inode_fixup.c: Only warn when inconsistent inode detected
[wimlib] / 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                 WARNING("An inconsistent hard link group that cannot be corrected has "
60                         "been detected");
61                 WARNING("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 /* Returns true iff the specified inode has any data streams with nonzero hash.
101  */
102 static bool
103 inode_has_data_streams(const struct wim_inode *inode)
104 {
105         for (unsigned i = 0; i <= inode->i_num_ads; i++)
106                 if (!is_zero_hash(inode_stream_hash(inode, i)))
107                         return true;
108         return false;
109 }
110
111 /* Returns true iff the specified dentry has any data streams with nonzero hash.
112  */
113 static bool
114 dentry_has_data_streams(const struct wim_dentry *dentry)
115 {
116         return inode_has_data_streams(dentry->d_inode);
117 }
118
119 static bool
120 inodes_consistent(const struct wim_inode *ref_inode,
121                   const struct wim_inode *inode)
122 {
123         if (ref_inode->i_security_id != inode->i_security_id) {
124                 WARNING("Security ID mismatch: %d != %d",
125                         ref_inode->i_security_id, inode->i_security_id);
126                 return false;
127         }
128
129         if (ref_inode->i_attributes != inode->i_attributes) {
130                 WARNING("Attributes mismatch: 0x%08x != 0x%08x",
131                         ref_inode->i_attributes, inode->i_attributes);
132                 return false;
133         }
134
135         if (inode_has_data_streams(inode)) {
136                 if (ref_inode->i_num_ads != inode->i_num_ads) {
137                         WARNING("Stream count mismatch: %u != %u",
138                                 ref_inode->i_num_ads, inode->i_num_ads);
139                         return false;
140                 }
141                 for (unsigned i = 0; i <= ref_inode->i_num_ads; i++) {
142                         const u8 *ref_hash, *hash;
143
144                         ref_hash = inode_stream_hash(ref_inode, i);
145                         hash = inode_stream_hash(inode, i);
146                         if (!hashes_equal(ref_hash, hash) && !is_zero_hash(hash)) {
147                                 WARNING("Stream hash mismatch");
148                                 return false;
149                         }
150                         if (i && !ads_entries_have_same_name(&ref_inode->i_ads_entries[i - 1],
151                                                              &inode->i_ads_entries[i - 1]))
152                         {
153                                 WARNING("Stream name mismatch");
154                                 return false;
155                         }
156                 }
157         }
158         return true;
159 }
160
161 /* Fix up a "true" inode and check for inconsistencies */
162 static int
163 fix_true_inode(struct wim_inode *inode, struct list_head *inode_list)
164 {
165         struct wim_dentry *dentry;
166         struct wim_dentry *ref_dentry = NULL;
167         struct wim_inode *ref_inode;
168         u64 last_ctime = 0;
169         u64 last_mtime = 0;
170         u64 last_atime = 0;
171
172         inode_for_each_dentry(dentry, inode) {
173                 if (!ref_dentry || dentry->d_inode->i_num_ads > ref_dentry->d_inode->i_num_ads)
174                         ref_dentry = dentry;
175                 if (dentry->d_inode->i_creation_time > last_ctime)
176                         last_ctime = dentry->d_inode->i_creation_time;
177                 if (dentry->d_inode->i_last_write_time > last_mtime)
178                         last_mtime = dentry->d_inode->i_last_write_time;
179                 if (dentry->d_inode->i_last_access_time > last_atime)
180                         last_atime = dentry->d_inode->i_last_access_time;
181         }
182
183         ref_inode = ref_dentry->d_inode;
184         wimlib_assert(ref_inode->i_nlink == 1);
185         list_add_tail(&ref_inode->i_list, inode_list);
186
187         list_del(&inode->i_dentry);
188         list_add(&ref_inode->i_dentry, &ref_dentry->d_alias);
189
190         inode_for_each_dentry(dentry, ref_inode) {
191                 if (dentry != ref_dentry) {
192                         if (!inodes_consistent(ref_inode, dentry->d_inode))
193                                 inconsistent_inode(ref_inode);
194                         /* Free the unneeded `struct wim_inode'. */
195                         wimlib_assert(dentry->d_inode->i_nlink == 1);
196                         free_inode(dentry->d_inode);
197                         dentry->d_inode = ref_inode;
198                         ref_inode->i_nlink++;
199                 }
200         }
201         ref_inode->i_creation_time = last_ctime;
202         ref_inode->i_last_write_time = last_mtime;
203         ref_inode->i_last_access_time = last_atime;
204         wimlib_assert(inode_link_count(ref_inode) == ref_inode->i_nlink);
205         return 0;
206 }
207
208 /*
209  * Fixes up a nominal inode.
210  *
211  * By a nominal inode we mean a group of two or more dentries that share the
212  * same hard link group ID.
213  *
214  * If dentries in the inode are found to be inconsistent, we may split the inode
215  * into several "true" inodes.
216  *
217  * After splitting up each nominal inode into the "true" inodes we will
218  * canonicalize the link group by getting rid of all the unnecessary `struct
219  * wim_inode's.  There will be just one `struct wim_inode' for each hard link
220  * group remaining.
221  */
222 static int
223 fix_nominal_inode(struct wim_inode *inode, struct list_head *inode_list,
224                   bool *ino_changes_needed)
225 {
226         struct wim_dentry *dentry;
227         struct hlist_node *cur, *tmp;
228         int ret;
229         size_t num_true_inodes;
230
231         LIST_HEAD(dentries_with_data_streams);
232         LIST_HEAD(dentries_with_no_data_streams);
233         HLIST_HEAD(true_inodes);
234
235         /* Create a list of dentries in the nominal inode that have at
236          * least one data stream with a non-zero hash, and another list that
237          * contains the dentries that have a zero hash for all data streams. */
238         inode_for_each_dentry(dentry, inode) {
239                 if (dentry_has_data_streams(dentry))
240                         list_add(&dentry->tmp_list, &dentries_with_data_streams);
241                 else
242                         list_add(&dentry->tmp_list, &dentries_with_no_data_streams);
243         }
244
245         /* If there are no dentries with data streams, we require the nominal
246          * inode to be a true inode */
247         if (list_empty(&dentries_with_data_streams)) {
248         #ifdef ENABLE_DEBUG
249                 unsigned nominal_group_size = inode_link_count(inode);
250                 if (nominal_group_size > 1) {
251                         DEBUG("Found link group of size %u without "
252                               "any data streams:", nominal_group_size);
253                         print_inode_dentries(inode);
254                         DEBUG("We are going to interpret it as true "
255                               "link group, provided that the dentries "
256                               "are consistent.");
257                 }
258         #endif
259                 return fix_true_inode(inode, inode_list);
260         }
261
262         /* One or more dentries had data streams specified.  We check each of
263          * these dentries for consistency with the others to form a set of true
264          * inodes. */
265         num_true_inodes = 0;
266         list_for_each_entry(dentry, &dentries_with_data_streams, tmp_list) {
267                 /* Look for a true inode that is consistent with this dentry and
268                  * add this dentry to it.  Or, if none of the true inodes are
269                  * consistent with this dentry, add a new one (if that happens,
270                  * we have split the hard link group). */
271                 hlist_for_each_entry(inode, cur, &true_inodes, i_hlist) {
272                         if (ref_inodes_consistent(inode, dentry->d_inode)) {
273                                 inode_add_dentry(dentry, inode);
274                                 goto next_dentry_2;
275                         }
276                 }
277                 num_true_inodes++;
278                 INIT_LIST_HEAD(&dentry->d_inode->i_dentry);
279                 inode_add_dentry(dentry, dentry->d_inode);
280                 hlist_add_head(&dentry->d_inode->i_hlist, &true_inodes);
281 next_dentry_2:
282                 ;
283         }
284
285         wimlib_assert(num_true_inodes != 0);
286
287         /* If there were dentries with no data streams, we require there to only
288          * be one true inode so that we know which inode to assign the
289          * streamless dentries to. */
290         if (!list_empty(&dentries_with_no_data_streams)) {
291                 if (num_true_inodes != 1) {
292                         ERROR("Hard link ambiguity detected!");
293                         ERROR("We split up inode 0x%"PRIx64" due to "
294                               "inconsistencies,", inode->i_ino);
295                         ERROR("but dentries with no stream information remained. "
296                               "We don't know which inode");
297                         ERROR("to assign them to.");
298                         ret = WIMLIB_ERR_INVALID_METADATA_RESOURCE;
299                         goto out_cleanup_true_inode_list;
300                 }
301                 inode = container_of(true_inodes.first, struct wim_inode, i_hlist);
302                 /* Assign the streamless dentries to the one and only true
303                  * inode. */
304                 list_for_each_entry(dentry, &dentries_with_no_data_streams, tmp_list)
305                         inode_add_dentry(dentry, inode);
306         }
307         if (num_true_inodes != 1) {
308         #ifdef ENABLE_DEBUG
309                 inode = container_of(true_inodes.first, struct wim_inode, i_hlist);
310
311                 tprintf(T("Split nominal inode 0x%"PRIx64" into %zu "
312                           "inodes:\n"), inode->i_ino, num_true_inodes);
313                 tputs(T("----------------------------------------------------"
314                         "--------------------------"));
315                 size_t i = 1;
316                 hlist_for_each_entry(inode, cur, &true_inodes, i_hlist) {
317                         tprintf(T("[Split inode %zu]\n"), i++);
318                         print_inode_dentries(inode);
319                         tputchar(T('\n'));
320                 }
321                 tputs(T("----------------------------------------------------"
322                         "--------------------------"));
323         #endif
324                 *ino_changes_needed = true;
325         }
326
327         hlist_for_each_entry_safe(inode, cur, tmp, &true_inodes, i_hlist) {
328                 hlist_del_init(&inode->i_hlist);
329                 ret = fix_true_inode(inode, inode_list);
330                 if (ret)
331                         goto out_cleanup_true_inode_list;
332         }
333         ret = 0;
334         goto out;
335 out_cleanup_true_inode_list:
336         hlist_for_each_entry_safe(inode, cur, tmp, &true_inodes, i_hlist)
337                 hlist_del_init(&inode->i_hlist);
338 out:
339         return ret;
340 }
341
342 static int
343 fix_inodes(struct wim_inode_table *table, struct list_head *inode_list,
344            bool *ino_changes_needed)
345 {
346         struct wim_inode *inode;
347         struct hlist_node *cur, *tmp;
348         int ret;
349         INIT_LIST_HEAD(inode_list);
350         for (u64 i = 0; i < table->capacity; i++) {
351                 hlist_for_each_entry_safe(inode, cur, tmp, &table->array[i], i_hlist) {
352                         hlist_del_init(&inode->i_hlist);
353                         ret = fix_nominal_inode(inode, inode_list, ino_changes_needed);
354                         if (ret)
355                                 return ret;
356                 }
357         }
358         list_splice_tail(&table->extra_inodes, inode_list);
359         return 0;
360 }
361
362 /* Insert a dentry into the inode table based on the inode number of the
363  * attached inode (which came from the hard link group ID field of the on-disk
364  * WIM dentry) */
365 static int
366 inode_table_insert(struct wim_dentry *dentry, void *_table)
367 {
368         struct wim_inode_table *table = _table;
369         struct wim_inode *d_inode = dentry->d_inode;
370
371         if (d_inode->i_ino == 0) {
372                 /* A dentry with a hard link group ID of 0 indicates that it's
373                  * in a hard link group by itself.  Add it to the list of extra
374                  * inodes rather than inserting it into the hash lists. */
375                 list_add_tail(&d_inode->i_list, &table->extra_inodes);
376         } else {
377                 size_t pos;
378                 struct wim_inode *inode;
379                 struct hlist_node *cur;
380
381                 /* Try adding this dentry to an existing inode */
382                 pos = d_inode->i_ino % table->capacity;
383                 hlist_for_each_entry(inode, cur, &table->array[pos], i_hlist) {
384                         if (inode->i_ino == d_inode->i_ino) {
385                                 if (unlikely((inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) ||
386                                              (d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)))
387                                 {
388                                         ERROR("Unsupported directory hard link "
389                                               "\"%"TS"\" <=> \"%"TS"\"",
390                                               dentry_full_path(dentry),
391                                               dentry_full_path(inode_first_dentry(inode)));
392                                         return WIMLIB_ERR_INVALID_METADATA_RESOURCE;
393                                 }
394                                 inode_add_dentry(dentry, inode);
395                                 return 0;
396                         }
397                 }
398
399                 /* No inode in the table has the same number as this one, so add
400                  * it to the table. */
401                 hlist_add_head(&d_inode->i_hlist, &table->array[pos]);
402
403                 /* XXX Make the table grow when too many entries have been
404                  * inserted. */
405                 table->num_entries++;
406         }
407         return 0;
408 }
409
410
411 /*
412  * dentry_tree_fix_inodes():
413  *
414  * This function takes as input a tree of WIM dentries that initially has a
415  * different inode associated with each dentry.  Sets of dentries that should
416  * share the same inode (a.k.a. hard link groups) are built using the i_ino
417  * field of each inode, then the link count and alias list for one inode in each
418  * set is set correctly and the unnecessary struct wim_inode's freed.  The
419  * effect is to correctly associate exactly one struct wim_inode with each
420  * original inode, regardless of how many dentries are aliases for that inode.
421  *
422  * The special inode number of 0 indicates that the dentry is in a hard link
423  * group by itself, and therefore has a 'struct wim_inode' with i_nlink=1 to
424  * itself.
425  *
426  * This function also checks the dentries in each hard link group for
427  * consistency.  In some WIMs, such as install.wim for some versions of Windows
428  * 7, dentries can share the same hard link group ID but not actually be hard
429  * linked to each other (based on conflicting information, such as file
430  * contents).  This should be an error, but this case needs be handled.  So,
431  * each "nominal" inode (the inode based on the inode numbers provided in the
432  * WIM) is examined for consistency and may be split into multiple "true" inodes
433  * that are maximally sized consistent sets of dentries.
434  *
435  * On success, the list of "true" inodes, linked by the i_hlist field,
436  * is returned in the hlist @inode_list.
437  *
438  * Return values:
439  *      WIMLIB_ERR_SUCCESS (0)
440  *      WIMLIB_ERR_INVALID_METADATA_RESOURCE
441  *      WIMLIB_ERR_NOMEM
442  */
443 int
444 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list)
445 {
446         struct wim_inode_table inode_tab;
447         int ret;
448         bool ino_changes_needed;
449         struct wim_inode *inode;
450
451         DEBUG("Inserting dentries into inode table");
452         ret = init_inode_table(&inode_tab, 9001);
453         if (ret)
454                 goto out;
455
456         ret = for_dentry_in_tree(root, inode_table_insert, &inode_tab);
457         if (ret)
458                 goto out_destroy_inode_table;
459
460         DEBUG("Cleaning up the hard link groups");
461         ino_changes_needed = false;
462         ret = fix_inodes(&inode_tab, inode_list, &ino_changes_needed);
463         if (ret)
464                 goto out_destroy_inode_table;
465
466         if (ino_changes_needed) {
467                 u64 cur_ino = 1;
468
469                 WARNING("The WIM image contains invalid hard links.  Fixing.");
470
471                 list_for_each_entry(inode, inode_list, i_list) {
472                         if (inode->i_nlink > 1)
473                                 inode->i_ino = cur_ino++;
474                         else
475                                 inode->i_ino = 0;
476                 }
477         }
478         /* On success, all the inodes have been moved to the image inode list,
479          * so there's no need to delete from from the hash lists in the inode
480          * table before freeing the hash buckets array directly. */
481         ret = 0;
482         goto out_destroy_inode_table_raw;
483 out_destroy_inode_table:
484         for (size_t i = 0; i < inode_tab.capacity; i++) {
485                 struct hlist_node *cur, *tmp;
486                 hlist_for_each_entry_safe(inode, cur, tmp, &inode_tab.array[i], i_hlist)
487                         hlist_del_init(&inode->i_hlist);
488         }
489         {
490                 struct wim_inode *tmp;
491                 list_for_each_entry_safe(inode, tmp, &inode_tab.extra_inodes, i_list)
492                         list_del_init(&inode->i_list);
493         }
494 out_destroy_inode_table_raw:
495         destroy_inode_table(&inode_tab);
496 out:
497         return ret;
498 }