Fix sequential extraction, and include progress info
[wimlib] / src / hardlink.c
1 /*
2  * hardlink.c
3  *
4  * Code to deal with hard links in WIMs.  Essentially, the WIM dentries are put
5  * into a hash table indexed by the inode ID field, then for each hard
6  * inode, a linked list is made to connect the dentries.
7  */
8
9 /*
10  * Copyright (C) 2012 Eric Biggers
11  *
12  * This file is part of wimlib, a library for working with WIM files.
13  *
14  * wimlib is free software; you can redistribute it and/or modify it under the
15  * terms of the GNU General Public License as published by the Free
16  * Software Foundation; either version 3 of the License, or (at your option)
17  * any later version.
18  *
19  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
20  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
21  * A PARTICULAR PURPOSE. See the GNU General Public License for more
22  * details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with wimlib; if not, see http://www.gnu.org/licenses/.
26  */
27
28 #include "wimlib_internal.h"
29 #include "dentry.h"
30 #include "list.h"
31 #include "lookup_table.h"
32
33 /*                             NULL        NULL
34  *                              ^           ^
35  *         dentry               |           |
36  *        /     \          -----------  -----------
37  *        |      dentry<---|  struct  | |  struct  |---> dentry
38  *        \     /          |  inode   | |  inode   |
39  *         dentry          ------------ ------------
40  *                              ^           ^
41  *                              |           |
42  *                              |           |                   dentry
43  *                         -----------  -----------            /      \
44  *               dentry<---|  struct  | |  struct  |---> dentry        dentry
45  *              /          |  inode   | |  inode   |           \      /
46  *         dentry          ------------ ------------            dentry
47  *                              ^           ^
48  *                              |           |
49  *                            -----------------
50  *        inode_table->array  | idx 0 | idx 1 |
51  *                            -----------------
52  */
53
54
55 int init_inode_table(struct inode_table *table, size_t capacity)
56 {
57         table->array = CALLOC(capacity, sizeof(table->array[0]));
58         if (!table->array) {
59                 ERROR("Cannot initalize inode table: out of memory");
60                 return WIMLIB_ERR_NOMEM;
61         }
62         table->num_entries  = 0;
63         table->capacity     = capacity;
64         INIT_HLIST_HEAD(&table->extra_inodes);
65         return 0;
66 }
67
68
69 static size_t inode_link_count(const struct inode *inode)
70 {
71         const struct list_head *cur;
72         size_t size = 0;
73         list_for_each(cur, &inode->dentry_list)
74                 size++;
75         return size;
76 }
77
78 /*
79  * Insert a dentry into the inode table based on its inode
80  * ID.
81  *
82  * If there is already a dentry in the table having the same inode ID,
83  * and the inode ID is not 0, the dentry is added to the circular
84  * linked list for that inode.
85  *
86  * If the inode ID is 0, this indicates a dentry that's in a hard link
87  * inode by itself (has a link count of 1).  We can't insert it into the hash
88  * table itself because we don't know what inode numbers are available to
89  * give it (this could be kept track of but would be more difficult).  Instead
90  * we keep a linked list of the single dentries, and assign them inode
91  * numbers later.
92  */
93 int inode_table_insert(struct dentry *dentry, void *__table)
94 {
95         struct inode_table *table = __table;
96         struct inode *d_inode = dentry->d_inode;
97
98         if (d_inode->ino == 0) {
99                 /* Single inode--- Add to the list of extra inodes (we can't put
100                  * it in the table itself because all the singles have a link
101                  * inode ID of 0) */
102                 hlist_add_head(&d_inode->hlist, &table->extra_inodes);
103
104                 wimlib_assert(d_inode->dentry_list.next == &dentry->inode_dentry_list);
105                 wimlib_assert(d_inode->dentry_list.prev == &dentry->inode_dentry_list);
106                 wimlib_assert(d_inode->link_count == 1);
107         } else {
108                 /* Inode that may have multiple corresponding dentries (the code
109                  * will work even if the inode actually contains only 1 dentry
110                  * though) */
111
112                 size_t pos;
113                 struct inode *inode;
114                 struct hlist_node *cur;
115
116                 /* Try adding to existing inode */
117                 pos = d_inode->ino % table->capacity;
118                 hlist_for_each_entry(inode, cur, &table->array[pos], hlist) {
119                         if (inode->ino == d_inode->ino) {
120                                 inode_add_dentry(dentry, inode);
121                                 inode->link_count++;
122                                 return 0;
123                         }
124                 }
125
126                 /* Add new inode to the table */
127                 hlist_add_head(&d_inode->hlist, &table->array[pos]);
128
129                 wimlib_assert(d_inode->dentry_list.next == &dentry->inode_dentry_list);
130                 wimlib_assert(d_inode->dentry_list.prev == &dentry->inode_dentry_list);
131                 wimlib_assert(d_inode->link_count == 1);
132
133                 /* XXX Make the table grow when too many entries have been
134                  * inserted. */
135                 table->num_entries++;
136         }
137         return 0;
138 }
139
140 /* Assign the inode numbers to dentries in a inode table, and return the
141  * next available inode ID. */
142 u64 assign_inode_numbers(struct hlist_head *inode_list)
143 {
144         DEBUG("Assigning inode numbers");
145         struct inode *inode;
146         struct hlist_node *cur;
147         u64 cur_ino = 1;
148         hlist_for_each_entry(inode, cur, inode_list, hlist) {
149                 inode->ino = cur_ino;
150                 cur_ino++;
151         }
152         return cur_ino;
153 }
154
155
156 static void print_inode_dentries(const struct inode *inode)
157 {
158         struct dentry *dentry;
159         inode_for_each_dentry(dentry, inode)
160                 printf("`%s'\n", dentry->full_path_utf8);
161 }
162
163 static void inconsistent_inode(const struct inode *inode)
164 {
165         ERROR("An inconsistent hard link group that we cannot correct has been "
166               "detected");
167         ERROR("The dentries are located at the following paths:");
168         print_inode_dentries(inode);
169 }
170
171 static bool ref_inodes_consistent(const struct inode * restrict ref_inode_1,
172                                   const struct inode * restrict ref_inode_2)
173 {
174         wimlib_assert(ref_inode_1 != ref_inode_2);
175
176         if (ref_inode_1->num_ads != ref_inode_2->num_ads)
177                 return false;
178         if (ref_inode_1->security_id != ref_inode_2->security_id
179             || ref_inode_1->attributes != ref_inode_2->attributes)
180                 return false;
181         for (unsigned i = 0; i <= ref_inode_1->num_ads; i++) {
182                 const u8 *ref_1_hash, *ref_2_hash;
183                 ref_1_hash = inode_stream_hash(ref_inode_1, i);
184                 ref_2_hash = inode_stream_hash(ref_inode_2, i);
185                 if (!hashes_equal(ref_1_hash, ref_2_hash))
186                         return false;
187                 if (i && !ads_entries_have_same_name(&ref_inode_1->ads_entries[i - 1],
188                                                      &ref_inode_2->ads_entries[i - 1]))
189                         return false;
190
191         }
192         return true;
193 }
194
195 static bool inodes_consistent(const struct inode * restrict ref_inode,
196                               const struct inode * restrict inode)
197 {
198         wimlib_assert(ref_inode != inode);
199
200         if (ref_inode->num_ads != inode->num_ads &&
201             inode->num_ads != 0)
202                 return false;
203         if (ref_inode->security_id != inode->security_id
204             || ref_inode->attributes != inode->attributes)
205                 return false;
206         for (unsigned i = 0; i <= min(ref_inode->num_ads, inode->num_ads); i++) {
207                 const u8 *ref_hash, *hash;
208                 ref_hash = inode_stream_hash(ref_inode, i);
209                 hash = inode_stream_hash(inode, i);
210                 if (!hashes_equal(ref_hash, hash) && !is_zero_hash(hash))
211                         return false;
212                 if (i && !ads_entries_have_same_name(&ref_inode->ads_entries[i - 1],
213                                                      &inode->ads_entries[i - 1]))
214                         return false;
215         }
216         return true;
217 }
218
219 /* Fix up a "true" inode and check for inconsistencies */
220 static int fix_true_inode(struct inode *inode, struct hlist_head *inode_list)
221 {
222         struct dentry *dentry;
223         struct dentry *ref_dentry = NULL;
224         struct inode *ref_inode;
225         u64 last_ctime = 0;
226         u64 last_mtime = 0;
227         u64 last_atime = 0;
228
229         inode_for_each_dentry(dentry, inode) {
230                 if (!ref_dentry || dentry->d_inode->num_ads > ref_dentry->d_inode->num_ads)
231                         ref_dentry = dentry;
232                 if (dentry->d_inode->creation_time > last_ctime)
233                         last_ctime = dentry->d_inode->creation_time;
234                 if (dentry->d_inode->last_write_time > last_mtime)
235                         last_mtime = dentry->d_inode->last_write_time;
236                 if (dentry->d_inode->last_access_time > last_atime)
237                         last_atime = dentry->d_inode->last_access_time;
238         }
239
240         ref_inode = ref_dentry->d_inode;
241         ref_inode->link_count = 1;
242         hlist_add_head(&ref_inode->hlist, inode_list);
243
244         list_del(&inode->dentry_list);
245         list_add(&ref_inode->dentry_list, &ref_dentry->inode_dentry_list);
246
247         inode_for_each_dentry(dentry, ref_inode) {
248                 if (dentry != ref_dentry) {
249                         if (!inodes_consistent(ref_inode, dentry->d_inode)) {
250                                 inconsistent_inode(ref_inode);
251                                 return WIMLIB_ERR_INVALID_DENTRY;
252                         }
253                         /* Free the unneeded `struct inode'. */
254                         free_inode(dentry->d_inode);
255                         dentry->d_inode = ref_inode;
256                         ref_inode->link_count++;
257                 }
258         }
259         ref_inode->creation_time = last_ctime;
260         ref_inode->last_write_time = last_mtime;
261         ref_inode->last_access_time = last_atime;
262         wimlib_assert(inode_link_count(ref_inode) == ref_inode->link_count);
263         return 0;
264 }
265
266 /*
267  * Fixes up a nominal inode.
268  *
269  * By a nominal inode we mean a group of two or more dentries that share
270  * the same hard link group ID.
271  *
272  * If dentries in the inode are found to be inconsistent, we may split the inode
273  * into several "true" inodes.
274  *
275  * After splitting up each nominal inode into the "true" inodes we will
276  * canonicalize the link group by getting rid of all the unnecessary `struct
277  * inodes'.  There will be just one `struct inode' for each hard link group
278  * remaining.
279  */
280 static int
281 fix_nominal_inode(struct inode *inode, struct hlist_head *inode_list)
282 {
283         struct dentry *dentry;
284         struct hlist_node *cur, *tmp;
285         int ret;
286         size_t num_true_inodes;
287
288         wimlib_assert(inode->link_count == inode_link_count(inode));
289
290         LIST_HEAD(dentries_with_data_streams);
291         LIST_HEAD(dentries_with_no_data_streams);
292         HLIST_HEAD(true_inodes);
293
294         /* Create a list of dentries in the nominal inode that have at
295          * least one data stream with a non-zero hash, and another list that
296          * contains the dentries that have a zero hash for all data streams. */
297         inode_for_each_dentry(dentry, inode) {
298                 for (unsigned i = 0; i <= dentry->d_inode->num_ads; i++) {
299                         const u8 *hash;
300                         hash = inode_stream_hash(dentry->d_inode, i);
301                         if (!is_zero_hash(hash)) {
302                                 list_add(&dentry->tmp_list,
303                                          &dentries_with_data_streams);
304                                 goto next_dentry;
305                         }
306                 }
307                 list_add(&dentry->tmp_list,
308                          &dentries_with_no_data_streams);
309         next_dentry:
310                 ;
311         }
312
313         /* If there are no dentries with data streams, we require the nominal
314          * inode to be a true inode */
315         if (list_empty(&dentries_with_data_streams)) {
316         #ifdef ENABLE_DEBUG
317                 if (inode->link_count > 1) {
318                         DEBUG("Found link group of size %u without "
319                               "any data streams:", inode->link_count);
320                         print_inode_dentries(inode);
321                         DEBUG("We are going to interpret it as true "
322                               "link group, provided that the dentries "
323                               "are consistent.");
324                 }
325         #endif
326                 return fix_true_inode(inode, inode_list);
327         }
328
329         /* One or more dentries had data streams specified.  We check each of
330          * these dentries for consistency with the others to form a set of true
331          * inodes. */
332         num_true_inodes = 0;
333         list_for_each_entry(dentry, &dentries_with_data_streams, tmp_list) {
334                 /* Look for a true inode that is consistent with this dentry and
335                  * add this dentry to it.  Or, if none of the true inodes are
336                  * consistent with this dentry, add a new one (if that happens,
337                  * we have split the hard link group). */
338                 hlist_for_each_entry(inode, cur, &true_inodes, hlist) {
339                         if (ref_inodes_consistent(inode, dentry->d_inode)) {
340                                 inode_add_dentry(dentry, inode);
341                                 goto next_dentry_2;
342                         }
343                 }
344                 num_true_inodes++;
345                 INIT_LIST_HEAD(&dentry->d_inode->dentry_list);
346                 inode_add_dentry(dentry, dentry->d_inode);
347                 hlist_add_head(&dentry->d_inode->hlist, &true_inodes);
348 next_dentry_2:
349                 ;
350         }
351
352         wimlib_assert(num_true_inodes != 0);
353
354         /* If there were dentries with no data streams, we require there to only
355          * be one true inode so that we know which inode to assign the
356          * streamless dentries to. */
357         if (!list_empty(&dentries_with_no_data_streams)) {
358                 if (num_true_inodes != 1) {
359                         ERROR("Hard inode ambiguity detected!");
360                         ERROR("We split up inode 0x%"PRIx64" due to "
361                               "inconsistencies,", inode->ino);
362                         ERROR("but dentries with no stream information remained. "
363                               "We don't know which inode");
364                         ERROR("to assign them to.");
365                         return WIMLIB_ERR_INVALID_DENTRY;
366                 }
367                 inode = container_of(true_inodes.first, struct inode, hlist);
368                 /* Assign the streamless dentries to the one and only true
369                  * inode. */
370                 list_for_each_entry(dentry, &dentries_with_no_data_streams, tmp_list)
371                         inode_add_dentry(dentry, inode);
372         }
373         #ifdef ENABLE_DEBUG
374         if (num_true_inodes != 1) {
375                 inode = container_of(true_inodes.first, struct inode, hlist);
376
377                 printf("Split nominal inode 0x%"PRIx64" into %zu "
378                        "inodes:\n",
379                        inode->ino, num_true_inodes);
380                 puts("------------------------------------------------------------------------------");
381                 size_t i = 1;
382                 hlist_for_each_entry(inode, cur, &true_inodes, hlist) {
383                         printf("[Split inode %zu]\n", i++);
384                         print_inode_dentries(inode);
385                         putchar('\n');
386                 }
387                 puts("------------------------------------------------------------------------------");
388         }
389         #endif
390
391         hlist_for_each_entry_safe(inode, cur, tmp, &true_inodes, hlist) {
392                 ret = fix_true_inode(inode, inode_list);
393                 if (ret != 0)
394                         return ret;
395         }
396         return 0;
397 }
398
399 /*
400  * Goes through each hard link group (dentries sharing the same hard link group
401  * ID field) that's been inserted into the inode table and shares the `struct
402  * inode's among members of each hard link group.
403  *
404  * In the process, the dentries belonging to each inode are checked for
405  * consistency.  If they contain data features that indicate they cannot really
406  * correspond to the same inode, this should be an error, but in reality this
407  * case needs to be handled, so we split the dentries into different inodes.
408  *
409  * After this function returns, the inodes are no longer in the inode table, and
410  * the inode table should be destroyed.  A list of the inodes, including all
411  * split inodes as well as the inodes that were good before, is returned in the
412  * list @inode_list.
413  */
414 int fix_inodes(struct inode_table *table, struct hlist_head *inode_list)
415 {
416         struct inode *inode;
417         struct hlist_node *cur, *tmp;
418         int ret;
419         INIT_HLIST_HEAD(inode_list);
420         for (u64 i = 0; i < table->capacity; i++) {
421                 hlist_for_each_entry_safe(inode, cur, tmp, &table->array[i], hlist) {
422                         ret = fix_nominal_inode(inode, inode_list);
423                         if (ret != 0)
424                                 return ret;
425                 }
426         }
427         hlist_for_each_safe(cur, tmp, &table->extra_inodes)
428                 hlist_add_head(cur, inode_list);
429         return 0;
430 }