]> wimlib.net Git - wimlib/blobdiff - src/lookup_table.c
Code to handle some weird siutations and bad WIMs
[wimlib] / src / lookup_table.c
index 38b9947ba814f0be1e655541c6156a9f8555fddb..0546f958a3108f41dc2b3dffc884a576567b8ea3 100644 (file)
@@ -32,7 +32,7 @@
 struct lookup_table *new_lookup_table(size_t capacity)
 {
        struct lookup_table *table;
-       struct lookup_table_entry **array;
+       struct hlist_head *array;
 
        table = MALLOC(sizeof(struct lookup_table));
        if (!table)
@@ -52,7 +52,7 @@ err:
        return NULL;
 }
 
-struct lookup_table_entry *new_lookup_table_entry()
+struct lookup_table_entry *new_lookup_table_entry(WIMStruct *wim)
 {
        struct lookup_table_entry *lte;
        
@@ -66,109 +66,78 @@ struct lookup_table_entry *new_lookup_table_entry()
 
        lte->part_number  = 1;
        lte->refcnt       = 1;
+       lte->wim          = wim;
        INIT_LIST_HEAD(&lte->lte_group_list);
        return lte;
 }
 
-
 void free_lookup_table_entry(struct lookup_table_entry *lte)
 {
        if (lte) {
                if (lte->staging_list.next)
                        list_del(&lte->staging_list);
-               FREE(lte->file_on_disk);
+               if (lte->resource_location != RESOURCE_IN_WIM &&
+                   lte->resource_location != RESOURCE_NONEXISTENT)
+                       FREE(lte->file_on_disk);
                FREE(lte);
        }
 }
 
+static int do_free_lookup_table_entry(struct lookup_table_entry *entry,
+                                     void *ignore)
+{
+       free_lookup_table_entry(entry);
+       return 0;
+}
+
+
+void free_lookup_table(struct lookup_table *table)
+{
+       DEBUG("Freeing lookup table");
+       if (table) {
+               if (table->array) {
+                       for_lookup_table_entry(table,
+                                              do_free_lookup_table_entry,
+                                              NULL);
+                       FREE(table->array);
+               }
+               FREE(table);
+       }
+}
+
 /*
  * Inserts an entry into the lookup table.
  *
- * @lookup_table:      A pointer to the lookup table.
- * @entry:             A pointer to the entry to insert.
+ * @table:     A pointer to the lookup table.
+ * @entry:     A pointer to the entry to insert.
  */
 void lookup_table_insert(struct lookup_table *table, 
                         struct lookup_table_entry *lte)
 {
-       size_t pos;
-       pos = lte->hash_short % table->capacity;
-       lte->next = table->array[pos];
-       table->array[pos] = lte;
+       size_t i = lte->hash_short % table->capacity;
+       hlist_add_head(&lte->hash_list, &table->array[i]);
+
        /* XXX Make the table grow when too many entries have been inserted. */
        table->num_entries++;
 }
 
 
-/* Unlinks a lookup table entry from the table; does not free it. */
-void lookup_table_unlink(struct lookup_table *table, 
-                        struct lookup_table_entry *lte)
-{
-       size_t pos;
-       struct lookup_table_entry *prev, *cur_entry, *next;
-
-       pos = lte->hash_short % table->capacity;
-       prev = NULL;
-       cur_entry = table->array[pos];
-
-       while (cur_entry) {
-               next = cur_entry->next;
-               if (cur_entry == lte) {
-                       if (prev)
-                               prev->next = next;
-                       else
-                               table->array[pos] = next;
-                       table->num_entries--;
-                       return;
-               }
-               prev = cur_entry;
-               cur_entry = next;
-       }
-}
-
-
-/* Decrement the reference count for the dentry having hash value @hash in the
- * lookup table.  The lookup table entry is unlinked and freed if there are no
- * references to in remaining.  */
-struct lookup_table_entry *
-lookup_table_decrement_refcnt(struct lookup_table* table, const u8 hash[])
-{
-       size_t pos = *(size_t*)hash % table->capacity;
-       struct lookup_table_entry *prev = NULL;
-       struct lookup_table_entry *entry = table->array[pos];
-       struct lookup_table_entry *next;
-       while (entry) {
-               next = entry->next;
-               if (memcmp(hash, entry->hash, WIM_HASH_SIZE) == 0) {
-                       wimlib_assert(entry->refcnt != 0);
-                       if (--entry->refcnt == 0) {
-                               if (entry->num_opened_fds == 0) {
-                                       free_lookup_table_entry(entry);
-                                       entry = NULL;
-                               }
-                               if (prev)
-                                       prev->next = next;
-                               else
-                                       table->array[pos] = next;
-                               break;
-                       }
-               }
-               prev = entry;
-               entry = next;
-       }
-       return entry;
-}
 
-/* Like lookup_table_decrement_refcnt(), but for when we already know the lookup
- * table entry. */
+/* Decrements the reference count for the lookup table entry @lte.  If its
+ * reference count reaches 0, it is unlinked from the lookup table.  If,
+ * furthermore, the entry has no opened file descriptors associated with it, the
+ * entry is freed.  */
 struct lookup_table_entry *
 lte_decrement_refcnt(struct lookup_table_entry *lte, struct lookup_table *table)
 {
-       wimlib_assert(lte->refcnt);
-       if (lte && --lte->refcnt == 0) {
-               lookup_table_unlink(table, lte);
-               if (lte->num_opened_fds == 0) {
-                       free_lookup_table_entry(lte);
-                       lte = NULL;
+       if (lte) {
+               wimlib_assert(lte->refcnt);
+               if (--lte->refcnt == 0) {
+                       lookup_table_unlink(table, lte);
+                       if (lte->num_opened_fds == 0) {
+                               free_lookup_table_entry(lte);
+                               lte = NULL;
+                       }
                }
        }
        return lte;
@@ -182,18 +151,17 @@ int for_lookup_table_entry(struct lookup_table *table,
                           int (*visitor)(struct lookup_table_entry *, void *),
                           void *arg)
 {
-       struct lookup_table_entry *entry, *next;
-       size_t i;
+       struct lookup_table_entry *lte;
+       struct hlist_node *pos, *tmp;
        int ret;
 
-       for (i = 0; i < table->capacity; i++) {
-               entry = table->array[i];
-               while (entry) {
-                       next = entry->next;
-                       ret = visitor(entry, arg);
+       for (size_t i = 0; i < table->capacity; i++) {
+               hlist_for_each_entry_safe(lte, pos, tmp, &table->array[i],
+                                         hash_list)
+               {
+                       ret = visitor(lte, arg);
                        if (ret != 0)
                                return ret;
-                       entry = next;
                }
        }
        return 0;
@@ -202,41 +170,37 @@ int for_lookup_table_entry(struct lookup_table *table,
 
 /*
  * Reads the lookup table from a WIM file.
- *
- * @fp:                The FILE* for the WIM file.
- * @offset:            The offset of the lookup table resource.
- * @size:              The size of the lookup table resource.
- * @lookup_table_ret:          A pointer to a struct lookup_table structure into which the
- *                             lookup table will be returned.
- * @return:            True on success, false on failure.
  */
-int read_lookup_table(FILE *fp, u64 offset, u64 size, 
-                     struct lookup_table **table_ret)
+int read_lookup_table(WIMStruct *w)
 {
-       size_t num_entries;
+       u64    num_entries;
        u8     buf[WIM_LOOKUP_TABLE_ENTRY_DISK_SIZE];
        int    ret;
        struct lookup_table *table;
-       const u8 *p;
-       struct lookup_table_entry *cur_entry;
 
        DEBUG("Reading lookup table: offset %"PRIu64", size %"PRIu64"",
-             offset, size);
+             w->hdr.lookup_table_res_entry.offset,
+             w->hdr.lookup_table_res_entry.original_size);
 
-       if (fseeko(fp, offset, SEEK_SET) != 0) {
+       if (fseeko(w->fp, w->hdr.lookup_table_res_entry.offset, SEEK_SET) != 0) {
                ERROR_WITH_ERRNO("Failed to seek to byte %"PRIu64" to read "
-                                "lookup table", offset);
+                                "lookup table",
+                                w->hdr.lookup_table_res_entry.offset);
                return WIMLIB_ERR_READ;
        }
 
-       num_entries = size / WIM_LOOKUP_TABLE_ENTRY_DISK_SIZE;
+       num_entries = w->hdr.lookup_table_res_entry.original_size /
+                     WIM_LOOKUP_TABLE_ENTRY_DISK_SIZE;
        table = new_lookup_table(num_entries * 2 + 1);
        if (!table)
                return WIMLIB_ERR_NOMEM;
 
        while (num_entries--) {
-               if (fread(buf, 1, sizeof(buf), fp) != sizeof(buf)) {
-                       if (feof(fp)) {
+               const u8 *p;
+               struct lookup_table_entry *cur_entry, *duplicate_entry;
+
+               if (fread(buf, 1, sizeof(buf), w->fp) != sizeof(buf)) {
+                       if (feof(w->fp)) {
                                ERROR("Unexpected EOF in WIM lookup table!");
                        } else {
                                ERROR_WITH_ERRNO("Error reading WIM lookup "
@@ -245,20 +209,46 @@ int read_lookup_table(FILE *fp, u64 offset, u64 size,
                        ret = WIMLIB_ERR_READ;
                        goto out;
                }
-               cur_entry = new_lookup_table_entry();
+               cur_entry = new_lookup_table_entry(w);
                if (!cur_entry) {
                        ret = WIMLIB_ERR_NOMEM;
                        goto out;
                }
+               cur_entry->wim = w;
+               cur_entry->resource_location = RESOURCE_IN_WIM;
                         
                p = get_resource_entry(buf, &cur_entry->resource_entry);
                p = get_u16(p, &cur_entry->part_number);
                p = get_u32(p, &cur_entry->refcnt);
-               p = get_bytes(p, WIM_HASH_SIZE, cur_entry->hash);
+               p = get_bytes(p, SHA1_HASH_SIZE, cur_entry->hash);
+
+               duplicate_entry = __lookup_resource(table, cur_entry->hash);
+               if (duplicate_entry) {
+                       ERROR("The WIM lookup table contains two entries with the "
+                             "same SHA1 message digest!");
+                       ERROR("The first entry is:");
+                       print_lookup_table_entry(duplicate_entry);
+                       ERROR("The second entry is:");
+                       print_lookup_table_entry(cur_entry);
+                       ret = WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY;
+                       goto out;
+               }
                lookup_table_insert(table, cur_entry);
+
+               if (!(cur_entry->resource_entry.flags & WIM_RESHDR_FLAG_COMPRESSED)
+                   && (cur_entry->resource_entry.size !=
+                     cur_entry->resource_entry.original_size))
+               {
+                       ERROR("Found uncompressed resource with original size "
+                             "not the same as compressed size");
+                       ERROR("The lookup table entry for the resource is as follows:");
+                       print_lookup_table_entry(cur_entry);
+                       ret = WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY;
+                       goto out;
+               }
        }
        DEBUG("Done reading lookup table.");
-       *table_ret = table;
+       w->lookup_table = table;
        return 0;
 out:
        free_lookup_table(table);
@@ -293,7 +283,7 @@ int write_lookup_table_entry(struct lookup_table_entry *lte, void *__out)
        p = put_resource_entry(buf, &lte->output_resource_entry);
        p = put_u16(p, lte->part_number);
        p = put_u32(p, lte->out_refcnt);
-       p = put_bytes(p, WIM_HASH_SIZE, lte->hash);
+       p = put_bytes(p, SHA1_HASH_SIZE, lte->hash);
        if (fwrite(buf, 1, sizeof(buf), out) != sizeof(buf)) {
                ERROR_WITH_ERRNO("Failed to write lookup table entry");
                return WIMLIB_ERR_WRITE;
@@ -301,23 +291,7 @@ int write_lookup_table_entry(struct lookup_table_entry *lte, void *__out)
        return 0;
 }
 
-static int do_free_lookup_table_entry(struct lookup_table_entry *entry,
-                                     void *ignore)
-{
-       free_lookup_table_entry(entry);
-       return 0;
-}
 
-void free_lookup_table(struct lookup_table *table)
-{
-       if (!table)
-               return;
-       if (table->array) {
-               for_lookup_table_entry(table, do_free_lookup_table_entry, NULL);
-               FREE(table->array);
-       }
-       FREE(table);
-}
 
 int zero_out_refcnts(struct lookup_table_entry *entry, void *ignore)
 {
@@ -325,21 +299,25 @@ int zero_out_refcnts(struct lookup_table_entry *entry, void *ignore)
        return 0;
 }
 
-int print_lookup_table_entry(struct lookup_table_entry *entry, void *ignore)
+void print_lookup_table_entry(const struct lookup_table_entry *lte)
 {
+       if (!lte) {
+               putchar('\n');
+               return;
+       }
        printf("Offset            = %"PRIu64" bytes\n", 
-              entry->resource_entry.offset);
+              lte->resource_entry.offset);
        printf("Size              = %"PRIu64" bytes\n", 
-              (u64)entry->resource_entry.size);
+              (u64)lte->resource_entry.size);
        printf("Original size     = %"PRIu64" bytes\n", 
-              entry->resource_entry.original_size);
-       printf("Part Number       = %hu\n", entry->part_number);
-       printf("Reference Count   = %u\n", entry->refcnt);
-       printf("Hash              = ");
-       print_hash(entry->hash);
+              lte->resource_entry.original_size);
+       printf("Part Number       = %hu\n", lte->part_number);
+       printf("Reference Count   = %u\n", lte->refcnt);
+       printf("Hash              = 0x");
+       print_hash(lte->hash);
        putchar('\n');
        printf("Flags             = ");
-       u8 flags = entry->resource_entry.flags;
+       u8 flags = lte->resource_entry.flags;
        if (flags & WIM_RESHDR_FLAG_COMPRESSED)
                fputs("WIM_RESHDR_FLAG_COMPRESSED, ", stdout);
        if (flags & WIM_RESHDR_FLAG_FREE)
@@ -349,9 +327,27 @@ int print_lookup_table_entry(struct lookup_table_entry *entry, void *ignore)
        if (flags & WIM_RESHDR_FLAG_SPANNED)
                fputs("WIM_RESHDR_FLAG_SPANNED, ", stdout);
        putchar('\n');
-       if (entry->file_on_disk)
-               printf("File on Disk      = `%s'\n", entry->file_on_disk);
+       switch (lte->resource_location) {
+       case RESOURCE_IN_WIM:
+               if (lte->wim->filename) {
+                       printf("WIM file          = `%s'\n",
+                              lte->wim->filename);
+               }
+               break;
+       case RESOURCE_IN_FILE_ON_DISK:
+               printf("File on Disk      = `%s'\n", lte->file_on_disk);
+               break;
+       case RESOURCE_IN_STAGING_FILE:
+               printf("Staging File      = `%s'\n", lte->staging_file_name);
+               break;
+       }
        putchar('\n');
+}
+
+static int do_print_lookup_table_entry(struct lookup_table_entry *lte,
+                                      void *ignore)
+{
+       print_lookup_table_entry(lte);
        return 0;
 }
 
@@ -361,29 +357,33 @@ int print_lookup_table_entry(struct lookup_table_entry *entry, void *ignore)
 WIMLIBAPI void wimlib_print_lookup_table(WIMStruct *w)
 {
        for_lookup_table_entry(w->lookup_table, 
-                              print_lookup_table_entry, NULL);
+                              do_print_lookup_table_entry,
+                              NULL);
 }
 
 /* 
  * Looks up an entry in the lookup table.
  */
 struct lookup_table_entry *
-__lookup_resource(const struct lookup_table *lookup_table, const u8 hash[])
+__lookup_resource(const struct lookup_table *table, const u8 hash[])
 {
-       size_t pos;
+       size_t i;
        struct lookup_table_entry *lte;
+       struct hlist_node *pos;
 
-       pos = *(size_t*)hash % lookup_table->capacity;
-       lte = lookup_table->array[pos];
-       while (lte) {
-               if (memcmp(hash, lte->hash, WIM_HASH_SIZE) == 0)
+       i = *(size_t*)hash % table->capacity;
+       hlist_for_each_entry(lte, pos, &table->array[i], hash_list)
+               if (hashes_equal(hash, lte->hash))
                        return lte;
-               lte = lte->next;
-       }
        return NULL;
 }
 
-/* Only for resolved lte's */
+/* 
+ * Finds the dentry, lookup table entry, and stream index for a WIM file stream,
+ * given a path name.
+ *
+ * This is only for pre-resolved dentries.
+ */
 int lookup_resource(WIMStruct *w, const char *path,
                    int lookup_flags,
                    struct dentry **dentry_ret,
@@ -431,13 +431,24 @@ out:
        return 0;
 }
 
-/* Resolve  a dentry's lookup table entries */
-static int dentry_resolve_ltes(struct dentry *dentry, void *__table)
+/* Resolve a dentry's lookup table entries 
+ *
+ * This replaces the SHA1 hash fields (which are used to lookup an entry in the
+ * lookup table) with pointers directly to the lookup table entries.  A circular
+ * linked list of streams sharing the same lookup table entry is created.
+ *
+ * This function always succeeds; unresolved lookup table entries are given a
+ * NULL pointer.
+ */
+int dentry_resolve_ltes(struct dentry *dentry, void *__table)
 {
        struct lookup_table *table = __table;
        struct lookup_table_entry *lte;
 
-       /* Default file stream */
+       if (dentry->resolved)
+               return 0;
+
+       /* Resolve the default file stream */
        lte = __lookup_resource(table, dentry->hash);
        if (lte)
                list_add(&dentry->lte_group_list.list, &lte->lte_group_list);
@@ -447,8 +458,8 @@ static int dentry_resolve_ltes(struct dentry *dentry, void *__table)
        dentry->lte_group_list.type = STREAM_TYPE_NORMAL;
        dentry->resolved = true;
 
-       /* Alternate data streams */
-       if (dentry->link_group_master_status != GROUP_SLAVE) {
+       /* Resolve the alternate data streams */
+       if (dentry->ads_entries_status != ADS_ENTRIES_USER) {
                for (u16 i = 0; i < dentry->num_ads; i++) {
                        struct ads_entry *cur_entry = &dentry->ads_entries[i];
 
@@ -465,8 +476,12 @@ static int dentry_resolve_ltes(struct dentry *dentry, void *__table)
        return 0;
 }
 
-/* Resolve all the lookup table entries of a dentry tree */
-void resolve_lookup_table_entries(struct dentry *root, struct lookup_table *table)
+struct lookup_table_entry *
+dentry_first_lte(const struct dentry *dentry, const struct lookup_table *table)
 {
-       for_dentry_in_tree(root, dentry_resolve_ltes, table);
+       if (dentry->resolved)
+               return dentry_first_lte_resolved(dentry);
+       else
+               return dentry_first_lte_unresolved(dentry, table);
 }
+