wimlib.net Git - wimlib/blob - src/inode_fixup.c

   1 /*
   2  * inode_fixup.c
   3  *
   4  * See dentry_tree_fix_inodes() for description.
   5  */
   6
   7 /*
   8  * Copyright (C) 2012, 2013 Eric Biggers
   9  *
  10  * This file is part of wimlib, a library for working with WIM files.
  11  *
  12  * wimlib is free software; you can redistribute it and/or modify it under the
  13  * terms of the GNU General Public License as published by the Free
  14  * Software Foundation; either version 3 of the License, or (at your option)
  15  * any later version.
  16  *
  17  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  18  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  19  * A PARTICULAR PURPOSE. See the GNU General Public License for more
  20  * details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  24  */
  25
  26 #ifdef HAVE_CONFIG_H
  27 #  include "config.h"
  28 #endif
  29
  30 #include "wimlib/dentry.h"
  31 #include "wimlib/error.h"
  32 #include "wimlib/inode.h"
  33 #include "wimlib/inode_table.h"
  34 #include "wimlib/lookup_table.h"
  35
  36 /* Manual link count of inode (normally we can just check i_nlink)  */
  37 static inline size_t
  38 inode_link_count(const struct wim_inode *inode)
  39 {
  40         const struct list_head *cur;
  41         size_t size = 0;
  42         list_for_each(cur, &inode->i_dentry)
  43                 size++;
  44         return size;
  45 }
  46
  47 static inline void
  48 print_inode_dentries(const struct wim_inode *inode)
  49 {
  50         struct wim_dentry *dentry;
  51         inode_for_each_dentry(dentry, inode)
  52                 tfprintf(stderr, T("%"TS"\n"), dentry_full_path(dentry));
  53 }
  54
  55 static void
  56 inconsistent_inode(const struct wim_inode *inode)
  57 {
  58         if (wimlib_print_errors) {
  59                 ERROR("An inconsistent hard link group that cannot be corrected has "
  60                       "been detected");
  61                 ERROR("The dentries are located at the following paths:");
  62                 print_inode_dentries(inode);
  63         }
  64 }
  65
  66 static bool
  67 ads_entries_have_same_name(const struct wim_ads_entry *entry_1,
  68                            const struct wim_ads_entry *entry_2)
  69 {
  70         return entry_1->stream_name_nbytes == entry_2->stream_name_nbytes &&
  71                memcmp(entry_1->stream_name, entry_2->stream_name,
  72                       entry_1->stream_name_nbytes) == 0;
  73 }
  74
  75 static bool
  76 ref_inodes_consistent(const struct wim_inode * restrict ref_inode_1,
  77                       const struct wim_inode * restrict ref_inode_2)
  78 {
  79         wimlib_assert(ref_inode_1 != ref_inode_2);
  80
  81         if (ref_inode_1->i_num_ads != ref_inode_2->i_num_ads)
  82                 return false;
  83         if (ref_inode_1->i_security_id != ref_inode_2->i_security_id
  84             || ref_inode_1->i_attributes != ref_inode_2->i_attributes)
  85                 return false;
  86         for (unsigned i = 0; i <= ref_inode_1->i_num_ads; i++) {
  87                 const u8 *ref_1_hash, *ref_2_hash;
  88                 ref_1_hash = inode_stream_hash(ref_inode_1, i);
  89                 ref_2_hash = inode_stream_hash(ref_inode_2, i);
  90                 if (!hashes_equal(ref_1_hash, ref_2_hash))
  91                         return false;
  92                 if (i && !ads_entries_have_same_name(&ref_inode_1->i_ads_entries[i - 1],
  93                                                      &ref_inode_2->i_ads_entries[i - 1]))
  94                         return false;
  95
  96         }
  97         return true;
  98 }
  99
 100 static bool
 101 inodes_consistent(const struct wim_inode * restrict ref_inode,
 102                   const struct wim_inode * restrict inode)
 103 {
 104         wimlib_assert(ref_inode != inode);
 105
 106         if (ref_inode->i_num_ads != inode->i_num_ads &&
 107             inode->i_num_ads != 0)
 108                 return false;
 109         if (ref_inode->i_security_id != inode->i_security_id
 110             || ref_inode->i_attributes != inode->i_attributes)
 111                 return false;
 112         for (unsigned i = 0; i <= min(ref_inode->i_num_ads, inode->i_num_ads); i++) {
 113                 const u8 *ref_hash, *hash;
 114                 ref_hash = inode_stream_hash(ref_inode, i);
 115                 hash = inode_stream_hash(inode, i);
 116                 if (!hashes_equal(ref_hash, hash) && !is_zero_hash(hash))
 117                         return false;
 118                 if (i && !ads_entries_have_same_name(&ref_inode->i_ads_entries[i - 1],
 119                                                      &inode->i_ads_entries[i - 1]))
 120                         return false;
 121         }
 122         return true;
 123 }
 124
 125 /* Fix up a "true" inode and check for inconsistencies */
 126 static int
 127 fix_true_inode(struct wim_inode *inode, struct list_head *inode_list)
 128 {
 129         struct wim_dentry *dentry;
 130         struct wim_dentry *ref_dentry = NULL;
 131         struct wim_inode *ref_inode;
 132         u64 last_ctime = 0;
 133         u64 last_mtime = 0;
 134         u64 last_atime = 0;
 135
 136         inode_for_each_dentry(dentry, inode) {
 137                 if (!ref_dentry || dentry->d_inode->i_num_ads > ref_dentry->d_inode->i_num_ads)
 138                         ref_dentry = dentry;
 139                 if (dentry->d_inode->i_creation_time > last_ctime)
 140                         last_ctime = dentry->d_inode->i_creation_time;
 141                 if (dentry->d_inode->i_last_write_time > last_mtime)
 142                         last_mtime = dentry->d_inode->i_last_write_time;
 143                 if (dentry->d_inode->i_last_access_time > last_atime)
 144                         last_atime = dentry->d_inode->i_last_access_time;
 145         }
 146
 147         ref_inode = ref_dentry->d_inode;
 148         wimlib_assert(ref_inode->i_nlink == 1);
 149         list_add_tail(&ref_inode->i_list, inode_list);
 150
 151         list_del(&inode->i_dentry);
 152         list_add(&ref_inode->i_dentry, &ref_dentry->d_alias);
 153
 154         inode_for_each_dentry(dentry, ref_inode) {
 155                 if (dentry != ref_dentry) {
 156                         if (!inodes_consistent(ref_inode, dentry->d_inode)) {
 157                                 inconsistent_inode(ref_inode);
 158                                 return WIMLIB_ERR_INVALID_METADATA_RESOURCE;
 159                         }
 160                         /* Free the unneeded `struct wim_inode'. */
 161                         wimlib_assert(dentry->d_inode->i_nlink == 1);
 162                         free_inode(dentry->d_inode);
 163                         dentry->d_inode = ref_inode;
 164                         ref_inode->i_nlink++;
 165                 }
 166         }
 167         ref_inode->i_creation_time = last_ctime;
 168         ref_inode->i_last_write_time = last_mtime;
 169         ref_inode->i_last_access_time = last_atime;
 170         wimlib_assert(inode_link_count(ref_inode) == ref_inode->i_nlink);
 171         return 0;
 172 }
 173
 174 /* Returns true iff the specified dentry has any data streams with nonzero hash.
 175  */
 176 static bool
 177 dentry_has_data_streams(const struct wim_dentry *dentry)
 178 {
 179         const struct wim_inode *inode = dentry->d_inode;
 180         for (unsigned i = 0; i <= inode->i_num_ads; i++) {
 181                 const u8 *hash = inode_stream_hash(inode, i);
 182                 if (!is_zero_hash(hash))
 183                         return true;
 184         }
 185         return false;
 186 }
 187
 188 /*
 189  * Fixes up a nominal inode.
 190  *
 191  * By a nominal inode we mean a group of two or more dentries that share the
 192  * same hard link group ID.
 193  *
 194  * If dentries in the inode are found to be inconsistent, we may split the inode
 195  * into several "true" inodes.
 196  *
 197  * After splitting up each nominal inode into the "true" inodes we will
 198  * canonicalize the link group by getting rid of all the unnecessary `struct
 199  * wim_inode's.  There will be just one `struct wim_inode' for each hard link
 200  * group remaining.
 201  */
 202 static int
 203 fix_nominal_inode(struct wim_inode *inode, struct list_head *inode_list,
 204                   bool *ino_changes_needed)
 205 {
 206         struct wim_dentry *dentry;
 207         struct hlist_node *cur, *tmp;
 208         int ret;
 209         size_t num_true_inodes;
 210
 211         LIST_HEAD(dentries_with_data_streams);
 212         LIST_HEAD(dentries_with_no_data_streams);
 213         HLIST_HEAD(true_inodes);
 214
 215         /* Create a list of dentries in the nominal inode that have at
 216          * least one data stream with a non-zero hash, and another list that
 217          * contains the dentries that have a zero hash for all data streams. */
 218         inode_for_each_dentry(dentry, inode) {
 219                 if (dentry_has_data_streams(dentry))
 220                         list_add(&dentry->tmp_list, &dentries_with_data_streams);
 221                 else
 222                         list_add(&dentry->tmp_list, &dentries_with_no_data_streams);
 223         }
 224
 225         /* If there are no dentries with data streams, we require the nominal
 226          * inode to be a true inode */
 227         if (list_empty(&dentries_with_data_streams)) {
 228         #ifdef ENABLE_DEBUG
 229                 unsigned nominal_group_size = inode_link_count(inode);
 230                 if (nominal_group_size > 1) {
 231                         DEBUG("Found link group of size %u without "
 232                               "any data streams:", nominal_group_size);
 233                         print_inode_dentries(inode);
 234                         DEBUG("We are going to interpret it as true "
 235                               "link group, provided that the dentries "
 236                               "are consistent.");
 237                 }
 238         #endif
 239                 return fix_true_inode(inode, inode_list);
 240         }
 241
 242         /* One or more dentries had data streams specified.  We check each of
 243          * these dentries for consistency with the others to form a set of true
 244          * inodes. */
 245         num_true_inodes = 0;
 246         list_for_each_entry(dentry, &dentries_with_data_streams, tmp_list) {
 247                 /* Look for a true inode that is consistent with this dentry and
 248                  * add this dentry to it.  Or, if none of the true inodes are
 249                  * consistent with this dentry, add a new one (if that happens,
 250                  * we have split the hard link group). */
 251                 hlist_for_each_entry(inode, cur, &true_inodes, i_hlist) {
 252                         if (ref_inodes_consistent(inode, dentry->d_inode)) {
 253                                 inode_add_dentry(dentry, inode);
 254                                 goto next_dentry_2;
 255                         }
 256                 }
 257                 num_true_inodes++;
 258                 INIT_LIST_HEAD(&dentry->d_inode->i_dentry);
 259                 inode_add_dentry(dentry, dentry->d_inode);
 260                 hlist_add_head(&dentry->d_inode->i_hlist, &true_inodes);
 261 next_dentry_2:
 262                 ;
 263         }
 264
 265         wimlib_assert(num_true_inodes != 0);
 266
 267         /* If there were dentries with no data streams, we require there to only
 268          * be one true inode so that we know which inode to assign the
 269          * streamless dentries to. */
 270         if (!list_empty(&dentries_with_no_data_streams)) {
 271                 if (num_true_inodes != 1) {
 272                         ERROR("Hard link ambiguity detected!");
 273                         ERROR("We split up inode 0x%"PRIx64" due to "
 274                               "inconsistencies,", inode->i_ino);
 275                         ERROR("but dentries with no stream information remained. "
 276                               "We don't know which inode");
 277                         ERROR("to assign them to.");
 278                         ret = WIMLIB_ERR_INVALID_METADATA_RESOURCE;
 279                         goto out_cleanup_true_inode_list;
 280                 }
 281                 inode = container_of(true_inodes.first, struct wim_inode, i_hlist);
 282                 /* Assign the streamless dentries to the one and only true
 283                  * inode. */
 284                 list_for_each_entry(dentry, &dentries_with_no_data_streams, tmp_list)
 285                         inode_add_dentry(dentry, inode);
 286         }
 287         if (num_true_inodes != 1) {
 288         #ifdef ENABLE_DEBUG
 289                 inode = container_of(true_inodes.first, struct wim_inode, i_hlist);
 290
 291                 tprintf(T("Split nominal inode 0x%"PRIx64" into %zu "
 292                           "inodes:\n"), inode->i_ino, num_true_inodes);
 293                 tputs(T("----------------------------------------------------"
 294                         "--------------------------"));
 295                 size_t i = 1;
 296                 hlist_for_each_entry(inode, cur, &true_inodes, i_hlist) {
 297                         tprintf(T("[Split inode %zu]\n"), i++);
 298                         print_inode_dentries(inode);
 299                         tputchar(T('\n'));
 300                 }
 301                 tputs(T("----------------------------------------------------"
 302                         "--------------------------"));
 303         #endif
 304                 *ino_changes_needed = true;
 305         }
 306
 307         hlist_for_each_entry_safe(inode, cur, tmp, &true_inodes, i_hlist) {
 308                 hlist_del_init(&inode->i_hlist);
 309                 ret = fix_true_inode(inode, inode_list);
 310                 if (ret)
 311                         goto out_cleanup_true_inode_list;
 312         }
 313         ret = 0;
 314         goto out;
 315 out_cleanup_true_inode_list:
 316         hlist_for_each_entry_safe(inode, cur, tmp, &true_inodes, i_hlist)
 317                 hlist_del_init(&inode->i_hlist);
 318 out:
 319         return ret;
 320 }
 321
 322 static int
 323 fix_inodes(struct wim_inode_table *table, struct list_head *inode_list,
 324            bool *ino_changes_needed)
 325 {
 326         struct wim_inode *inode;
 327         struct hlist_node *cur, *tmp;
 328         int ret;
 329         INIT_LIST_HEAD(inode_list);
 330         for (u64 i = 0; i < table->capacity; i++) {
 331                 hlist_for_each_entry_safe(inode, cur, tmp, &table->array[i], i_hlist) {
 332                         hlist_del_init(&inode->i_hlist);
 333                         ret = fix_nominal_inode(inode, inode_list, ino_changes_needed);
 334                         if (ret)
 335                                 return ret;
 336                 }
 337         }
 338         list_splice_tail(&table->extra_inodes, inode_list);
 339         return 0;
 340 }
 341
 342 /* Insert a dentry into the inode table based on the inode number of the
 343  * attached inode (which came from the hard link group ID field of the on-disk
 344  * WIM dentry) */
 345 static int
 346 inode_table_insert(struct wim_dentry *dentry, void *_table)
 347 {
 348         struct wim_inode_table *table = _table;
 349         struct wim_inode *d_inode = dentry->d_inode;
 350
 351         if (d_inode->i_ino == 0) {
 352                 /* A dentry with a hard link group ID of 0 indicates that it's
 353                  * in a hard link group by itself.  Add it to the list of extra
 354                  * inodes rather than inserting it into the hash lists. */
 355                 list_add_tail(&d_inode->i_list, &table->extra_inodes);
 356         } else {
 357                 size_t pos;
 358                 struct wim_inode *inode;
 359                 struct hlist_node *cur;
 360
 361                 /* Try adding this dentry to an existing inode */
 362                 pos = d_inode->i_ino % table->capacity;
 363                 hlist_for_each_entry(inode, cur, &table->array[pos], i_hlist) {
 364                         if (inode->i_ino == d_inode->i_ino) {
 365                                 if (unlikely((inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) ||
 366                                              (d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)))
 367                                 {
 368                                         ERROR("Unsupported directory hard link "
 369                                               "\"%"TS"\" <=> \"%"TS"\"",
 370                                               dentry_full_path(dentry),
 371                                               dentry_full_path(inode_first_dentry(inode)));
 372                                         return WIMLIB_ERR_INVALID_METADATA_RESOURCE;
 373                                 }
 374                                 inode_add_dentry(dentry, inode);
 375                                 return 0;
 376                         }
 377                 }
 378
 379                 /* No inode in the table has the same number as this one, so add
 380                  * it to the table. */
 381                 hlist_add_head(&d_inode->i_hlist, &table->array[pos]);
 382
 383                 /* XXX Make the table grow when too many entries have been
 384                  * inserted. */
 385                 table->num_entries++;
 386         }
 387         return 0;
 388 }
 389
 390
 391 /*
 392  * dentry_tree_fix_inodes():
 393  *
 394  * This function takes as input a tree of WIM dentries that initially has a
 395  * different inode associated with each dentry.  Sets of dentries that should
 396  * share the same inode (a.k.a. hard link groups) are built using the i_ino
 397  * field of each inode, then the link count and alias list for one inode in each
 398  * set is set correctly and the unnecessary struct wim_inode's freed.  The
 399  * effect is to correctly associate exactly one struct wim_inode with each
 400  * original inode, regardless of how many dentries are aliases for that inode.
 401  *
 402  * The special inode number of 0 indicates that the dentry is in a hard link
 403  * group by itself, and therefore has a 'struct wim_inode' with i_nlink=1 to
 404  * itself.
 405  *
 406  * This function also checks the dentries in each hard link group for
 407  * consistency.  In some WIMs, such as install.wim for some versions of Windows
 408  * 7, dentries can share the same hard link group ID but not actually be hard
 409  * linked to each other (based on conflicting information, such as file
 410  * contents).  This should be an error, but this case needs be handled.  So,
 411  * each "nominal" inode (the inode based on the inode numbers provided in the
 412  * WIM) is examined for consistency and may be split into multiple "true" inodes
 413  * that are maximally sized consistent sets of dentries.
 414  *
 415  * On success, the list of "true" inodes, linked by the i_hlist field,
 416  * is returned in the hlist @inode_list.
 417  *
 418  * Return values:
 419  *      WIMLIB_ERR_SUCCESS (0)
 420  *      WIMLIB_ERR_INVALID_METADATA_RESOURCE
 421  *      WIMLIB_ERR_NOMEM
 422  */
 423 int
 424 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list)
 425 {
 426         struct wim_inode_table inode_tab;
 427         int ret;
 428         bool ino_changes_needed;
 429         struct wim_inode *inode;
 430
 431         DEBUG("Inserting dentries into inode table");
 432         ret = init_inode_table(&inode_tab, 9001);
 433         if (ret)
 434                 goto out;
 435
 436         ret = for_dentry_in_tree(root, inode_table_insert, &inode_tab);
 437         if (ret)
 438                 goto out_destroy_inode_table;
 439
 440         DEBUG("Cleaning up the hard link groups");
 441         ino_changes_needed = false;
 442         ret = fix_inodes(&inode_tab, inode_list, &ino_changes_needed);
 443         if (ret)
 444                 goto out_destroy_inode_table;
 445
 446         if (ino_changes_needed) {
 447                 u64 cur_ino = 1;
 448
 449                 WARNING("The WIM image contains invalid hard links.  Fixing.");
 450
 451                 list_for_each_entry(inode, inode_list, i_list) {
 452                         if (inode->i_nlink > 1)
 453                                 inode->i_ino = cur_ino++;
 454                         else
 455                                 inode->i_ino = 0;
 456                 }
 457         }
 458         /* On success, all the inodes have been moved to the image inode list,
 459          * so there's no need to delete from from the hash lists in the inode
 460          * table before freeing the hash buckets array directly. */
 461         ret = 0;
 462         goto out_destroy_inode_table_raw;
 463 out_destroy_inode_table:
 464         for (size_t i = 0; i < inode_tab.capacity; i++) {
 465                 struct hlist_node *cur, *tmp;
 466                 hlist_for_each_entry_safe(inode, cur, tmp, &inode_tab.array[i], i_hlist)
 467                         hlist_del_init(&inode->i_hlist);
 468         }
 469         {
 470                 struct wim_inode *tmp;
 471                 list_for_each_entry_safe(inode, tmp, &inode_tab.extra_inodes, i_list)
 472                         list_del_init(&inode->i_list);
 473         }
 474 out_destroy_inode_table_raw:
 475         destroy_inode_table(&inode_tab);
 476 out:
 477         return ret;
 478 }