]> wimlib.net Git - wimlib/blobdiff - src/lookup_table.c
inode updates (IN PROGRESS)
[wimlib] / src / lookup_table.c
index e6b8fb2cbafcc86ee033b9d4dd5b579e0b9886d3..61cc5a83ab663132dc87b3d581c9b64fefa2862a 100644 (file)
  * This file is part of wimlib, a library for working with WIM files.
  *
  * wimlib is free software; you can redistribute it and/or modify it under the
- * terms of the GNU Lesser General Public License as published by the Free
- * Software Foundation; either version 2.1 of the License, or (at your option)
+ * terms of the GNU General Public License as published by the Free
+ * Software Foundation; either version 3 of the License, or (at your option)
  * any later version.
  *
  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+ * A PARTICULAR PURPOSE. See the GNU General Public License for more
  * details.
  *
- * You should have received a copy of the GNU Lesser General Public License
+ * You should have received a copy of the GNU General Public License
  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  */
 
 #include "io.h"
 #include <errno.h>
 
+#ifdef WITH_FUSE
+#include <unistd.h>
+#endif
+
 struct lookup_table *new_lookup_table(size_t capacity)
 {
        struct lookup_table *table;
@@ -52,7 +56,7 @@ err:
        return NULL;
 }
 
-struct lookup_table_entry *new_lookup_table_entry(WIMStruct *wim)
+struct lookup_table_entry *new_lookup_table_entry()
 {
        struct lookup_table_entry *lte;
        
@@ -66,17 +70,39 @@ struct lookup_table_entry *new_lookup_table_entry(WIMStruct *wim)
 
        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) {
+#ifdef WITH_FUSE
                if (lte->staging_list.next)
                        list_del(&lte->staging_list);
-               FREE(lte->file_on_disk);
+#endif
+               switch (lte->resource_location) {
+               case RESOURCE_IN_STAGING_FILE:
+               case RESOURCE_IN_ATTACHED_BUFFER:
+               case RESOURCE_IN_FILE_ON_DISK:
+                       wimlib_assert(((void*)&lte->file_on_disk ==
+                                     (void*)&lte->staging_file_name)
+                                     && ((void*)&lte->file_on_disk ==
+                                     (void*)&lte->attached_buffer));
+                       FREE(lte->file_on_disk);
+                       break;
+#ifdef WITH_NTFS_3G
+               case RESOURCE_IN_NTFS_VOLUME:
+                       if (lte->ntfs_loc) {
+                               FREE(lte->ntfs_loc->path_utf8);
+                               FREE(lte->ntfs_loc->stream_name_utf16);
+                               FREE(lte->ntfs_loc);
+                       }
+                       break;
+#endif
+               default:
+                       break;
+               }
+               FREE(lte->extracted_file);
                FREE(lte);
        }
 }
@@ -91,7 +117,7 @@ static int do_free_lookup_table_entry(struct lookup_table_entry *entry,
 
 void free_lookup_table(struct lookup_table *table)
 {
-       DEBUG("Freeing lookup table");
+       DEBUG2("Freeing lookup table");
        if (table) {
                if (table->array) {
                        for_lookup_table_entry(table,
@@ -119,7 +145,14 @@ void lookup_table_insert(struct lookup_table *table,
        table->num_entries++;
 }
 
-
+static void finalize_lte(struct lookup_table_entry *lte)
+{
+       #ifdef WITH_FUSE
+       if (lte->resource_location == RESOURCE_IN_STAGING_FILE)
+               unlink(lte->staging_file_name);
+       #endif
+       free_lookup_table_entry(lte);
+}
 
 /* Decrements the reference count for the lookup table entry @lte.  If its
  * reference count reaches 0, it is unlinked from the lookup table.  If,
@@ -132,8 +165,11 @@ lte_decrement_refcnt(struct lookup_table_entry *lte, struct lookup_table *table)
                wimlib_assert(lte->refcnt);
                if (--lte->refcnt == 0) {
                        lookup_table_unlink(table, lte);
-                       if (lte->num_opened_fds == 0) {
-                               free_lookup_table_entry(lte);
+               #ifdef WITH_FUSE
+                       if (lte->num_opened_fds == 0)
+               #endif
+                       {
+                               finalize_lte(lte);
                                lte = NULL;
                        }
                }
@@ -141,6 +177,23 @@ lte_decrement_refcnt(struct lookup_table_entry *lte, struct lookup_table *table)
        return lte;
 }
 
+#ifdef WITH_FUSE
+struct lookup_table_entry *
+lte_decrement_num_opened_fds(struct lookup_table_entry *lte,
+                            struct lookup_table *table)
+{
+       if (lte) {
+               wimlib_assert(lte->num_opened_fds);
+               if (--lte->num_opened_fds == 0 && lte->refcnt == 0) {
+                       lookup_table_unlink(table, lte);
+                       finalize_lte(lte);
+                       lte = NULL;
+               }
+       }
+       return lte;
+}
+#endif
+
 /* 
  * Calls a function on all the entries in the lookup table.  Stop early and
  * return nonzero if any call to the function returns nonzero.
@@ -175,6 +228,7 @@ int read_lookup_table(WIMStruct *w)
        u8     buf[WIM_LOOKUP_TABLE_ENTRY_DISK_SIZE];
        int    ret;
        struct lookup_table *table;
+       struct lookup_table_entry *cur_entry = NULL, *duplicate_entry;
 
        DEBUG("Reading lookup table: offset %"PRIu64", size %"PRIu64"",
              w->hdr.lookup_table_res_entry.offset,
@@ -195,7 +249,6 @@ int read_lookup_table(WIMStruct *w)
 
        while (num_entries--) {
                const u8 *p;
-               struct lookup_table_entry *cur_entry;
 
                if (fread(buf, 1, sizeof(buf), w->fp) != sizeof(buf)) {
                        if (feof(w->fp)) {
@@ -207,7 +260,7 @@ int read_lookup_table(WIMStruct *w)
                        ret = WIMLIB_ERR_READ;
                        goto out;
                }
-               cur_entry = new_lookup_table_entry(w);
+               cur_entry = new_lookup_table_entry();
                if (!cur_entry) {
                        ret = WIMLIB_ERR_NOMEM;
                        goto out;
@@ -219,11 +272,54 @@ int read_lookup_table(WIMStruct *w)
                p = get_u16(p, &cur_entry->part_number);
                p = get_u32(p, &cur_entry->refcnt);
                p = get_bytes(p, SHA1_HASH_SIZE, cur_entry->hash);
+
+               if (cur_entry->part_number != w->hdr.part_number) {
+                       ERROR("A lookup table entry in part %hu of the WIM "
+                             "points to part %hu",
+                             w->hdr.part_number, cur_entry->part_number);
+                       ret = WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY;
+                       goto out_free_cur_entry;
+                       
+               }
+
+               if (is_zero_hash(cur_entry->hash)) {
+                       ERROR("The WIM lookup table contains an entry with a "
+                             "SHA1 message digest of all 0's");
+                       ret = WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY;
+                       goto out_free_cur_entry;
+               }
+
+               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_free_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_free_cur_entry;
+               }
                lookup_table_insert(table, cur_entry);
+
        }
        DEBUG("Done reading lookup table.");
        w->lookup_table = table;
        return 0;
+out_free_cur_entry:
+       FREE(cur_entry);
 out:
        free_lookup_table(table);
        return ret;
@@ -241,10 +337,6 @@ int write_lookup_table_entry(struct lookup_table_entry *lte, void *__out)
 
        out = __out;
 
-       /* do not write lookup table entries for empty files */
-       if (lte->output_resource_entry.original_size == 0)
-               return 0;
-
        /* Don't write entries that have not had file resources or metadata
         * resources written for them. */
        if (lte->out_refcnt == 0)
@@ -266,14 +358,26 @@ int write_lookup_table_entry(struct lookup_table_entry *lte, void *__out)
 }
 
 
+int lte_zero_real_refcnt(struct lookup_table_entry *lte, void *ignore)
+{
+       lte->real_refcnt = 0;
+       return 0;
+}
+
+int lte_zero_out_refcnt(struct lookup_table_entry *lte, void *ignore)
+{
+       lte->out_refcnt = 0;
+       return 0;
+}
 
-int zero_out_refcnts(struct lookup_table_entry *entry, void *ignore)
+int lte_free_extracted_file(struct lookup_table_entry *lte, void *ignone)
 {
-       entry->out_refcnt = 0;
+       FREE(lte->extracted_file);
+       lte->extracted_file = NULL;
        return 0;
 }
 
-void print_lookup_table_entry(struct lookup_table_entry *lte)
+void print_lookup_table_entry(const struct lookup_table_entry *lte)
 {
        if (!lte) {
                putchar('\n');
@@ -314,6 +418,8 @@ void print_lookup_table_entry(struct lookup_table_entry *lte)
        case RESOURCE_IN_STAGING_FILE:
                printf("Staging File      = `%s'\n", lte->staging_file_name);
                break;
+       default:
+               break;
        }
        putchar('\n');
 }
@@ -356,44 +462,58 @@ __lookup_resource(const struct lookup_table *table, const u8 hash[])
  * 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.
+ * This is only for pre-resolved inodes.
  */
 int lookup_resource(WIMStruct *w, const char *path,
                    int lookup_flags,
                    struct dentry **dentry_ret,
                    struct lookup_table_entry **lte_ret,
-                   unsigned *stream_idx_ret)
+                   u16 *stream_idx_ret)
 {
        struct dentry *dentry;
        struct lookup_table_entry *lte;
-       unsigned stream_idx;
+       u16 stream_idx;
+       const char *stream_name = NULL;
+       struct inode *inode;
+       char *p = NULL;
+
+       if (lookup_flags & LOOKUP_FLAG_ADS_OK) {
+               stream_name = path_stream_name(path);
+               if (stream_name) {
+                       p = (char*)stream_name - 1;
+                       *p = '\0';
+               }
+       }
+
        dentry = get_dentry(w, path);
+       if (p)
+               *p = ':';
        if (!dentry)
                return -ENOENT;
 
-       wimlib_assert(dentry->resolved);
+       inode = dentry->inode;
+
+       wimlib_assert(inode->resolved);
 
-       lte = dentry->lte;
        if (!(lookup_flags & LOOKUP_FLAG_DIRECTORY_OK)
-             && dentry_is_directory(dentry))
+             && inode_is_directory(inode))
                return -EISDIR;
-       stream_idx = 0;
-       if (lookup_flags & LOOKUP_FLAG_ADS_OK) {
-               const char *stream_name = path_stream_name(path);
-               if (stream_name) {
-                       size_t stream_name_len = strlen(stream_name);
-                       for (u16 i = 0; i < dentry->num_ads; i++) {
-                               if (ads_entry_has_name(&dentry->ads_entries[i],
-                                                      stream_name,
-                                                      stream_name_len))
-                               {
-                                       stream_idx = i + 1;
-                                       lte = dentry->ads_entries[i].lte;
-                                       goto out;
-                               }
-                       }
+
+       if (stream_name) {
+               struct ads_entry *ads_entry;
+               u16 ads_idx;
+               ads_entry = inode_get_ads_entry(inode, stream_name,
+                                               &ads_idx);
+               if (ads_entry) {
+                       stream_idx = ads_idx + 1;
+                       lte = ads_entry->lte;
+                       goto out;
+               } else {
                        return -ENOENT;
                }
+       } else {
+               lte = inode->lte;
+               stream_idx = 0;
        }
 out:
        if (dentry_ret)
@@ -405,6 +525,24 @@ out:
        return 0;
 }
 
+static void inode_resolve_ltes(struct inode *inode, struct lookup_table *table)
+{
+       struct lookup_table_entry *lte;
+
+       /* Resolve the default file stream */
+       lte = __lookup_resource(table, inode->hash);
+       inode->lte = lte;
+       inode->resolved = true;
+
+       /* Resolve the alternate data streams */
+       for (u16 i = 0; i < inode->num_ads; i++) {
+               struct ads_entry *cur_entry = inode->ads_entries[i];
+
+               lte = __lookup_resource(table, cur_entry->hash);
+               cur_entry->lte = lte;
+       }
+}
+
 /* Resolve a dentry's lookup table entries 
  *
  * This replaces the SHA1 hash fields (which are used to lookup an entry in the
@@ -414,48 +552,36 @@ out:
  * This function always succeeds; unresolved lookup table entries are given a
  * NULL pointer.
  */
-int dentry_resolve_ltes(struct dentry *dentry, void *__table)
+int dentry_resolve_ltes(struct dentry *dentry, void *table)
 {
-       struct lookup_table *table = __table;
-       struct lookup_table_entry *lte;
-
-       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);
-       else
-               INIT_LIST_HEAD(&dentry->lte_group_list.list);
-       dentry->lte = lte;
-       dentry->lte_group_list.type = STREAM_TYPE_NORMAL;
-       dentry->resolved = true;
-
-       /* 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];
-
-                       lte = __lookup_resource(table, cur_entry->hash);
-                       if (lte)
-                               list_add(&cur_entry->lte_group_list.list,
-                                        &lte->lte_group_list);
-                       else
-                               INIT_LIST_HEAD(&cur_entry->lte_group_list.list);
-                       cur_entry->lte = lte;
-                       cur_entry->lte_group_list.type = STREAM_TYPE_ADS;
-               }
-       }
+       if (!dentry->inode->resolved)
+               inode_resolve_ltes(dentry->inode, table);
        return 0;
 }
 
+/* Return the lookup table entry for the unnamed data stream of an inode, or
+ * NULL if there is none.
+ *
+ * You'd think this would be easier than it actually is, since the unnamed data
+ * stream should be the one referenced from the inode itself.  Alas, if there
+ * are named data streams, Microsoft's "imagex.exe" program will put the unnamed
+ * data stream in one of the alternate data streams instead of inside the WIM
+ * dentry itself.  So we need to check the alternate data streams too.
+ *
+ * Also, note that a dentry may appear to have than one unnamed stream, but if
+ * the SHA1 message digest is all 0's then the corresponding stream does not
+ * really "count" (this is the case for the inode's own file stream when the
+ * file stream that should be there is actually in one of the alternate stream
+ * entries.).  This is despite the fact that we may need to extract such a
+ * missing entry as an empty file or empty named data stream.
+ */
 struct lookup_table_entry *
-dentry_first_lte(const struct dentry *dentry, const struct lookup_table *table)
+inode_unnamed_lte(const struct inode *inode,
+                  const struct lookup_table *table)
 {
-       if (dentry->resolved)
-               return dentry_first_lte_resolved(dentry);
+       if (inode->resolved)
+               return inode_unnamed_lte_resolved(inode);
        else
-               return dentry_first_lte_unresolved(dentry, table);
+               return inode_unnamed_lte_unresolved(inode, table);
 }