5e8ae1a94b9c7e654a5bd4b1354ec1c6514de310
[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 hard link group ID field, then for each hard
6  * link group, 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  *        \     /          |link_group| |link_group|       
39  *         dentry          ------------ ------------
40  *                              ^           ^
41  *                              |           |
42  *                              |           |                   dentry
43  *                         -----------  -----------            /      \
44  *               dentry<---|  struct  | |  struct  |---> dentry        dentry
45  *              /          |link_group| |link_group|           \      /
46  *         dentry          ------------ ------------            dentry
47  *                              ^           ^
48  *                              |           |
49  *                            -----------------
50  *    link_group_table->array | idx 0 | idx 1 | 
51  *                            -----------------
52  */
53
54 /* Hard link group; it's identified by its hard link group ID and points to a
55  * circularly linked list of dentries. */
56 struct link_group {
57         u64 link_group_id;
58
59         /* Pointer to use to make a singly-linked list of link groups. */
60         struct link_group *next;
61
62         /* This is a pointer to the circle and not part of the circle itself.
63          * This makes it easy to iterate through other dentries hard-linked to a
64          * given dentry without having to find the "head" of the list first. */
65         struct list_head *dentry_list;
66 };
67
68 /* Hash table to find hard link groups, identified by their hard link group ID.
69  * */
70 struct link_group_table {
71         /* Fields for the hash table */
72         struct link_group **array;
73         u64 num_entries;
74         u64 capacity;
75
76         /* 
77          * Linked list of "extra" groups.  These may be:
78          *
79          * - Hard link groups of size 1, which are all allowed to have 0 for
80          *   their hard link group ID, meaning we cannot insert them into the
81          *   hash table before calling assign_link_group_ids().
82          *
83          * - Groups we create ourselves by splitting a nominal hard link group
84          *   due to inconsistencies in the dentries.  These groups will share a
85          *   hard link group ID with some other group until
86          *   assign_link_group_ids() is called.
87          */
88         struct link_group *extra_groups;
89 };
90
91 /* Returns pointer to a new link group table having the specified capacity */
92 struct link_group_table *new_link_group_table(size_t capacity)
93 {
94         struct link_group_table *table;
95         struct link_group **array;
96
97         table = MALLOC(sizeof(struct link_group_table));
98         if (!table)
99                 goto err;
100         array = CALLOC(capacity, sizeof(array[0]));
101         if (!array) {
102                 FREE(table);
103                 goto err;
104         }
105         table->num_entries  = 0;
106         table->capacity     = capacity;
107         table->array        = array;
108         table->extra_groups = NULL;
109         return table;
110 err:
111         ERROR("Failed to allocate memory for link group table with capacity %zu",
112               capacity);
113         return NULL;
114 }
115
116 /* 
117  * Insert a dentry into the hard link group table based on its hard link group
118  * ID.
119  *
120  * If there is already a dentry in the table having the same hard link group ID,
121  * and the hard link group ID is not 0, the dentry is added to the circular
122  * linked list for that hard link group.
123  *
124  * If the hard link group ID is 0, this indicates a dentry that's in a hard link
125  * group by itself (has a link count of 1).  We can't insert it into the hash
126  * table itself because we don't know what hard link group IDs are available to
127  * give it (this could be kept track of but would be more difficult).  Instead
128  * we keep a linked list of the single dentries, and assign them hard link group
129  * IDs later.
130  */
131 int link_group_table_insert(struct dentry *dentry, void *__table)
132 {
133         struct link_group_table *table = __table;
134         size_t pos;
135         struct link_group *group;
136
137         if (dentry->link_group_id == 0) {
138                 /* Single group--- Add to the list of extra groups (we can't put
139                  * it in the table itself because all the singles have a link
140                  * group ID of 0) */
141                 group = MALLOC(sizeof(struct link_group));
142                 if (!group)
143                         return WIMLIB_ERR_NOMEM;
144                 group->link_group_id = 0;
145                 group->next          = table->extra_groups;
146                 table->extra_groups  = group;
147                 INIT_LIST_HEAD(&dentry->link_group_list);
148                 group->dentry_list = &dentry->link_group_list;
149         } else {
150                 /* Hard link group that may contain multiple dentries (the code
151                  * will work even if the group actually contains only 1 dentry
152                  * though) */
153
154                 /* Try adding to existing hard link group */
155                 pos = dentry->link_group_id % table->capacity;
156                 group = table->array[pos];
157                 while (group) {
158                         if (group->link_group_id == dentry->link_group_id) {
159                                 list_add(&dentry->link_group_list,
160                                          group->dentry_list);
161                                 return 0;
162                         }
163                         group = group->next;
164                 }
165
166                 /* Add new hard link group to the table */
167
168                 group = MALLOC(sizeof(struct link_group));
169                 if (!group)
170                         return WIMLIB_ERR_NOMEM;
171                 group->link_group_id   = dentry->link_group_id;
172                 group->next            = table->array[pos];
173                 INIT_LIST_HEAD(&dentry->link_group_list);
174                 group->dentry_list = &dentry->link_group_list;
175                 table->array[pos]      = group;
176
177                 /* XXX Make the table grow when too many entries have been
178                  * inserted. */
179                 table->num_entries++;
180         }
181         return 0;
182 }
183
184 static void free_link_group_list(struct link_group *group)
185 {
186         struct link_group *next_group;
187         while (group) {
188                 next_group = group->next;
189                 FREE(group);
190                 group = next_group;
191         }
192 }
193
194 /* Frees a link group table. */
195 void free_link_group_table(struct link_group_table *table)
196 {
197         if (table) {
198                 if (table->array)
199                         for (size_t i = 0; i < table->capacity; i++)
200                                 free_link_group_list(table->array[i]);
201                 free_link_group_list(table->extra_groups);
202                 FREE(table);
203         }
204 }
205
206 static u64
207 assign_link_group_ids_to_list(struct link_group *group, u64 id,
208                               struct link_group **extra_groups)
209 {
210         struct dentry *dentry;
211         struct list_head *cur_head;
212         struct link_group *prev_group = NULL;
213         struct link_group *cur_group = group;
214         while (cur_group) {
215                 cur_head = cur_group->dentry_list;
216                 do {
217                         dentry = container_of(cur_head,
218                                               struct dentry,
219                                               link_group_list);
220                         dentry->link_group_id = id;
221                         cur_head = cur_head->next;
222                 } while (cur_head != cur_group->dentry_list);
223                 cur_group->link_group_id = id;
224                 id++;
225                 prev_group = cur_group;
226                 cur_group = cur_group->next;
227         }
228         if (group && extra_groups) {
229                 prev_group->next = *extra_groups;
230                 *extra_groups = group;
231         }
232         return id;
233 }
234
235 /* Insert the link groups in the `extra_groups' list into the hash table */
236 static void insert_extra_groups(struct link_group_table *table)
237 {
238         struct link_group *group, *next_group;
239         size_t pos;
240
241         group = table->extra_groups;
242         while (group) {
243                 next_group        = group->next;
244                 pos               = group->link_group_id % table->capacity;
245                 group->next       = table->array[pos];
246                 table->array[pos] = group;
247                 group             = next_group;
248         }
249         table->extra_groups = NULL;
250 }
251
252 /* Assign the link group IDs to dentries in a link group table, and return the
253  * next available link group ID. */
254 u64 assign_link_group_ids(struct link_group_table *table)
255 {
256         DEBUG("Assigning link groups");
257         struct link_group *extra_groups = table->extra_groups;
258
259         /* Assign consecutive link group IDs to each link group in the hash
260          * table */
261         u64 id = 1;
262         for (size_t i = 0; i < table->capacity; i++) {
263                 id = assign_link_group_ids_to_list(table->array[i], id,
264                                                    &table->extra_groups);
265                 table->array[i] = NULL;
266         }
267
268         /* Assign link group IDs to the "extra" link groups and insert them into
269          * the hash table */
270         id = assign_link_group_ids_to_list(extra_groups, id, NULL);
271         insert_extra_groups(table);
272         return id;
273 }
274
275
276
277 static void inconsistent_link_group(const struct dentry *first_dentry)
278 {
279         const struct dentry *dentry = first_dentry;
280
281         ERROR("An inconsistent hard link group that we cannot correct has been "
282               "detected");
283         ERROR("The dentries are located at the following paths:");
284         do {
285                 ERROR("`%s'", dentry->full_path_utf8);
286         } while ((dentry = container_of(dentry->link_group_list.next,
287                                         const struct dentry,
288                                         link_group_list)) != first_dentry);
289 }
290
291 static bool ref_dentries_consistent(const struct dentry * restrict ref_dentry_1,
292                                     const struct dentry * restrict ref_dentry_2)
293 {
294         wimlib_assert(ref_dentry_1 != ref_dentry_2);
295
296         if (ref_dentry_1->num_ads != ref_dentry_2->num_ads)
297                 return false;
298         if (ref_dentry_1->security_id != ref_dentry_2->security_id
299             || ref_dentry_1->attributes != ref_dentry_2->attributes)
300                 return false;
301         for (unsigned i = 0; i <= ref_dentry_1->num_ads; i++) {
302                 const u8 *ref_1_hash, *ref_2_hash;
303                 ref_1_hash = dentry_stream_hash(ref_dentry_1, i);
304                 ref_2_hash = dentry_stream_hash(ref_dentry_2, i);
305                 if (!hashes_equal(ref_1_hash, ref_2_hash))
306                         return false;
307                 if (i && !ads_entries_have_same_name(&ref_dentry_1->ads_entries[i - 1],
308                                                      &ref_dentry_2->ads_entries[i - 1]))
309                         return false;
310
311         }
312         return true;
313 }
314
315 static bool dentries_consistent(const struct dentry * restrict ref_dentry,
316                                 const struct dentry * restrict dentry)
317 {
318         wimlib_assert(ref_dentry != dentry);
319
320         if (ref_dentry->num_ads != dentry->num_ads && dentry->num_ads != 0)
321                 return false;
322         if (ref_dentry->security_id != dentry->security_id
323             || ref_dentry->attributes != dentry->attributes)
324                 return false;
325         for (unsigned i = 0; i <= min(ref_dentry->num_ads, dentry->num_ads); i++) {
326                 const u8 *ref_hash, *hash;
327                 ref_hash = dentry_stream_hash(ref_dentry, i);
328                 hash = dentry_stream_hash(dentry, i);
329                 if (!hashes_equal(ref_hash, hash) && !is_zero_hash(hash))
330                         return false;
331                 if (i && !ads_entries_have_same_name(&ref_dentry->ads_entries[i - 1],
332                                                      &dentry->ads_entries[i - 1]))
333                         return false;
334         }
335         return true;
336 }
337
338 #ifdef ENABLE_DEBUG
339 static void
340 print_dentry_list(const struct dentry *first_dentry)
341 {
342         const struct dentry *dentry = first_dentry;
343         do {
344                 printf("`%s'\n", dentry->full_path_utf8);
345         } while ((dentry = container_of(dentry->link_group_list.next,
346                                         struct dentry,
347                                         link_group_list)) != first_dentry);
348 }
349 #endif
350
351 /* Fix up a "true" link group and check for inconsistencies */
352 static int
353 fix_true_link_group(struct dentry *first_dentry)
354 {
355         struct dentry *dentry;
356         struct dentry *ref_dentry = NULL;
357         u64 last_ctime = 0;
358         u64 last_mtime = 0;
359         u64 last_atime = 0;
360
361         dentry = first_dentry;
362         do {
363                 if (!ref_dentry || ref_dentry->num_ads == 0)
364                         ref_dentry = dentry;
365                 if (dentry->creation_time > last_ctime)
366                         last_ctime = dentry->creation_time;
367                 if (dentry->last_write_time > last_mtime)
368                         last_mtime = dentry->last_write_time;
369                 if (dentry->last_access_time > last_atime)
370                         last_atime = dentry->last_access_time;
371         } while ((dentry = container_of(dentry->link_group_list.next,
372                                         struct dentry,
373                                         link_group_list)) != first_dentry);
374
375
376         ref_dentry->ads_entries_status = ADS_ENTRIES_OWNER;
377         dentry = first_dentry;
378         do {
379                 if (dentry != ref_dentry) {
380                         if (!dentries_consistent(ref_dentry, dentry)) {
381                                 inconsistent_link_group(first_dentry);
382                                 return WIMLIB_ERR_INVALID_DENTRY;
383                         }
384                         copy_hash(dentry->hash, ref_dentry->hash);
385                         dentry_free_ads_entries(dentry);
386                         dentry->num_ads            = ref_dentry->num_ads;
387                         dentry->ads_entries        = ref_dentry->ads_entries;
388                         dentry->ads_entries_status = ADS_ENTRIES_USER;
389                 }
390                 dentry->creation_time    = last_ctime;
391                 dentry->last_write_time  = last_mtime;
392                 dentry->last_access_time = last_atime;
393         } while ((dentry = container_of(dentry->link_group_list.next,
394                                         struct dentry,
395                                         link_group_list)) != first_dentry);
396         return 0;
397 }
398
399 /* 
400  * Fixes up a nominal link group.
401  *
402  * By a nominal link group we mean a group of two or more dentries that share
403  * the same hard link group ID.
404  *
405  * If dentries in the group are found to be inconsistent, we may split the group
406  * into several "true" hard link groups.  @new_groups points to a linked list of
407  * these split groups, and if we create any, they will be added to this list.
408  *
409  * After splitting up each nominal link group into the "true" link groups we
410  * will canonicalize the link groups.  To do this, we:
411  *
412  *      - Assign all the dentries in the link group the most recent timestamp
413  *      among all the corresponding timestamps in the link group, for each of
414  *      the three categories of time stamps.
415  *
416  *      - Make sure the dentry->hash field is valid in all the dentries, if
417  *      possible (this field may be all zeroes, and in the context of a hard
418  *      link group this must be interpreted as implicitly refering to the same
419  *      stream as another dentry in the hard link group that does NOT have all
420  *      zeroes for this field).
421  *
422  *      - Make sure dentry->num_ads is the same in all the dentries in the link
423  *      group.  In some cases, it's possible for it to be set to 0 when it
424  *      actually must be interpreted as being the same as the number of
425  *      alternate data streams in another dentry in the hard link group that has
426  *      a nonzero number of alternate data streams.
427  *
428  *      - Make sure only the dentry->ads_entries array is only allocated for one
429  *      dentry in the hard link group.  This dentry will have
430  *      dentry->ads_entries_status set to ADS_ENTRIES_OWNER, while the others
431  *      will have dentry->ads_entries_status set to ADS_ENTRIES_USER.
432  */
433 static int
434 fix_nominal_link_group(struct link_group *group,
435                        struct link_group **new_groups)
436 {
437         struct dentry *tmp, *dentry, *ref_dentry;
438         int ret;
439         size_t num_true_link_groups;
440         struct list_head *head;
441
442         LIST_HEAD(dentries_with_data_streams);
443         LIST_HEAD(dentries_with_no_data_streams);
444         LIST_HEAD(true_link_groups);
445
446         /* Create a list of dentries in the nominal hard link group that have at
447          * least one data stream with a non-zero hash, and another list that
448          * contains the dentries that have a zero hash for all data streams. */
449         dentry = container_of(group->dentry_list, struct dentry,
450                               link_group_list);
451         do {
452                 for (unsigned i = 0; i <= dentry->num_ads; i++) {
453                         const u8 *hash;
454                         hash = dentry_stream_hash(dentry, i);
455                         if (!is_zero_hash(hash)) {
456                                 list_add(&dentry->tmp_list,
457                                          &dentries_with_data_streams);
458                                 goto next_dentry;
459                         }
460                 }
461                 list_add(&dentry->tmp_list,
462                          &dentries_with_no_data_streams);
463         next_dentry:
464                 dentry = container_of(dentry->link_group_list.next,
465                                       struct dentry,
466                                       link_group_list);
467         } while (&dentry->link_group_list != group->dentry_list);
468
469         /* If there are no dentries with data streams, we require the nominal
470          * link group to be a true link group */
471         if (list_empty(&dentries_with_data_streams)) {
472         #ifdef ENABLE_DEBUG
473                 {
474                         size_t size = dentry_link_group_size(dentry);
475                         if (size > 1) {
476                                 DEBUG("Found link group of size %zu without "
477                                       "any data streams:", size);
478                                 print_dentry_list(dentry);
479                                 DEBUG("We are going to interpret it as true "
480                                       "link group, provided that the dentries "
481                                       "are consistent.");
482                         }
483                 }
484         #endif
485                 return fix_true_link_group(container_of(group->dentry_list,
486                                                         struct dentry,
487                                                         link_group_list));
488         }
489
490         /* One or more dentries had data streams specified.  We check each of
491          * these dentries for consistency with the others to form a set of true
492          * link groups. */
493         num_true_link_groups = 0;
494         list_for_each_entry_safe(dentry, tmp, &dentries_with_data_streams,
495                                  tmp_list)
496         {
497                 list_del(&dentry->tmp_list);
498
499                 /* Look for a true link group that is consistent with
500                  * this dentry and add this dentry to it.  Or, if none
501                  * of the true link groups are consistent with this
502                  * dentry, make a new one. */
503                 list_for_each_entry(ref_dentry, &true_link_groups, tmp_list) {
504                         if (ref_dentries_consistent(ref_dentry, dentry)) {
505                                 list_add(&dentry->link_group_list,
506                                          &ref_dentry->link_group_list);
507                                 goto next_dentry_2;
508                         }
509                 }
510                 num_true_link_groups++;
511                 list_add(&dentry->tmp_list, &true_link_groups);
512                 INIT_LIST_HEAD(&dentry->link_group_list);
513 next_dentry_2:
514                 ;
515         }
516
517         wimlib_assert(num_true_link_groups != 0);
518
519         /* If there were dentries with no data streams, we require there to only
520          * be one true link group so that we know which link group to assign the
521          * streamless dentries to. */
522         if (!list_empty(&dentries_with_no_data_streams)) {
523                 if (num_true_link_groups != 1) {
524                         ERROR("Hard link group ambiguity detected!");
525                         ERROR("We split up hard link group 0x%"PRIx64" due to "
526                               "inconsistencies,", group->link_group_id);
527                         ERROR("but dentries with no stream information remained. "
528                               "We don't know which true hard link");
529                         ERROR("group to assign them to.");
530                         return WIMLIB_ERR_INVALID_DENTRY;
531                 }
532                 /* Assign the streamless dentries to the one and only true link
533                  * group. */
534                 ref_dentry = container_of(true_link_groups.next,
535                                           struct dentry,
536                                           tmp_list);
537                 list_for_each_entry(dentry, &dentries_with_no_data_streams, tmp_list)
538                         list_add(&dentry->link_group_list, &ref_dentry->link_group_list);
539         }
540         if (num_true_link_groups != 1) {
541                 #ifdef ENABLE_DEBUG
542                 {
543                         printf("Split nominal link group 0x%"PRIx64" into %zu "
544                                "link groups:\n",
545                                group->link_group_id, num_true_link_groups);
546                         puts("------------------------------------------------------------------------------");
547                         size_t i = 1;
548                         list_for_each_entry(dentry, &true_link_groups, tmp_list) {
549                                 printf("[Split link group %zu]\n", i++);
550                                 print_dentry_list(dentry);
551                                 putchar('\n');
552                         }
553                         puts("------------------------------------------------------------------------------");
554                 }
555                 #endif
556         }
557
558         list_for_each_entry(dentry, &true_link_groups, tmp_list) {
559                 ret = fix_true_link_group(dentry);
560                 if (ret != 0)
561                         return ret;
562         }
563
564         /* Make new `struct link_group's for the new link groups */
565         for (head = true_link_groups.next->next;
566              head != &true_link_groups;
567              head = head->next)
568         {
569                 dentry = container_of(head, struct dentry, tmp_list);
570                 group = MALLOC(sizeof(*group));
571                 if (!group) {
572                         ERROR("Out of memory");
573                         return WIMLIB_ERR_NOMEM;
574                 }
575                 group->link_group_id = dentry->link_group_id;
576                 group->dentry_list = &dentry->link_group_list;
577                 group->next = *new_groups;
578                 *new_groups = group;
579         }
580         return 0;
581 }
582
583 /*
584  * Goes through each link group and shares the ads_entries (Alternate Data
585  * Stream entries) field of each dentry among members of a hard link group.
586  *
587  * In the process, the dentries in each link group are checked for consistency.
588  * If they contain data features that indicate they cannot really be in the same
589  * hard link group, this should be an error, but in reality this case needs to
590  * be handled, so we split the dentries into different hard link groups.
591  *
592  * One of the dentries in each hard link group group is arbitrarily assigned the
593  * role of "owner" of the memory pointed to by the @ads_entries field,
594  * (ADS_ENTRIES_OWNER), while the others are "users" (ADS_ENTRIES_USER) who are
595  * not allowed to free the memory.
596  */
597 int fix_link_groups(struct link_group_table *table)
598 {
599         for (u64 i = 0; i < table->capacity; i++) {
600                 struct link_group *group = table->array[i];
601                 while (group) {
602                         int ret;
603                         ret = fix_nominal_link_group(group, &table->extra_groups);
604                         if (ret != 0)
605                                 return ret;
606                         group = group->next;
607                 }
608         }
609         return 0;
610 }