*
* Lookup table, implemented as a hash table, that maps dentries to file
* resources.
- *
+ */
+
+/*
* Copyright (C) 2012 Eric Biggers
*
- * wimlib - Library for working with WIM files
+ * This file is part of wimlib, a library for working with WIM files.
*
- * This library 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) any
- * later version.
+ * 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)
+ * any later version.
*
- * This library 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 details.
+ * 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
+ * details.
*
- * You should have received a copy of the GNU Lesser General Public License along
- * with this library; if not, write to the Free Software Foundation, Inc., 59
- * Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with wimlib; if not, see http://www.gnu.org/licenses/.
*/
#include "wimlib_internal.h"
#include "lookup_table.h"
#include "io.h"
+#include <errno.h>
struct lookup_table *new_lookup_table(size_t capacity)
{
struct lookup_table *table;
- struct lookup_table_entry **array;
+ struct hlist_head *array;
- table = CALLOC(1, sizeof(struct lookup_table));
+ table = MALLOC(sizeof(struct lookup_table));
if (!table)
goto err;
array = CALLOC(capacity, sizeof(array[0]));
table->array = array;
return table;
err:
- ERROR("Failed to allocate memory for lookup table with capacity "
- "%zu\n", capacity);
+ ERROR("Failed to allocate memory for lookup table with capacity %zu",
+ capacity);
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;
- lte = MALLOC(sizeof(struct lookup_table_entry));
+ lte = CALLOC(1, sizeof(struct lookup_table_entry));
if (!lte) {
ERROR("Out of memory (tried to allocate %zu bytes for "
- "lookup table entry)\n",
- sizeof(struct lookup_table_entry));
+ "lookup table entry)",
+ sizeof(struct lookup_table_entry));
return NULL;
}
- lte->file_on_disk = NULL;
- lte->other_wim_fp = NULL;
- lte->next = NULL;
lte->part_number = 1;
lte->refcnt = 1;
- lte->staging_num_times_opened = 0;
+ lte->wim = wim;
+ INIT_LIST_HEAD(<e->lte_group_list);
return lte;
}
+void free_lookup_table_entry(struct lookup_table_entry *lte)
+{
+ if (lte) {
+ if (lte->staging_list.next)
+ list_del(<e->staging_list);
+ 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 = *(size_t*)lte->hash % table->capacity;
- lte->next = table->array[pos];
- table->array[pos] = lte;
+ size_t i = lte->hash_short % table->capacity;
+ hlist_add_head(<e->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 = *(size_t*)lte->hash % 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. */
-void lookup_table_decrement_refcnt(struct lookup_table* table, const u8 hash[])
+/* 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)
{
- 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) {
- free_lookup_table_entry(entry);
- if (prev)
- prev->next = next;
- else
- table->array[pos] = next;
+ 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;
}
}
- prev = entry;
- entry = next;
}
-}
-
-/*
- * Looks up an entry in the lookup table.
- */
-struct lookup_table_entry *lookup_resource(const struct lookup_table *lookup_table,
- const u8 hash[])
-{
- size_t pos;
- struct lookup_table_entry *lte;
-
- pos = *(size_t*)hash % lookup_table->capacity;
- lte = lookup_table->array[pos];
- while (lte) {
- if (memcmp(hash, lte->hash, WIM_HASH_SIZE) == 0)
- return lte;
- lte = lte->next;
- }
- return NULL;
+ return lte;
}
/*
* return nonzero if any call to the function returns nonzero.
*/
int for_lookup_table_entry(struct lookup_table *table,
- int (*visitor)(struct lookup_table_entry *, void *), void *arg)
+ 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;
/*
* 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"\n",
- offset, size);
+ DEBUG("Reading lookup table: offset %"PRIu64", size %"PRIu64"",
+ w->hdr.lookup_table_res_entry.offset,
+ w->hdr.lookup_table_res_entry.original_size);
- if (fseeko(fp, offset, SEEK_SET) != 0) {
- ERROR("Failed to seek to byte %"PRIu64" to read lookup table: "
- "%m\n", offset);
+ 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",
+ 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)) {
- ERROR("Unexpected EOF in lookup table!\n");
+ 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("Stream read error while reading "
- "lookup table!\n");
+ ERROR_WITH_ERRNO("Error reading WIM lookup "
+ "table");
}
ret = WIMLIB_ERR_READ;
- goto err;
+ goto out;
}
- cur_entry = new_lookup_table_entry();
+ cur_entry = new_lookup_table_entry(w);
if (!cur_entry) {
ret = WIMLIB_ERR_NOMEM;
- goto err;
+ 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, sizeof(cur_entry->hash), 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.\n");
- *table_ret = table;
+ DEBUG("Done reading lookup table.");
+ w->lookup_table = table;
return 0;
-err:
+out:
free_lookup_table(table);
return ret;
}
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)
return 0;
- if (lte->output_resource_entry.flags & WIM_RESHDR_FLAG_METADATA) {
- DEBUG("Writing metadata entry at %lu\n", ftello(out));
- }
+ if (lte->output_resource_entry.flags & WIM_RESHDR_FLAG_METADATA)
+ DEBUG("Writing metadata entry at %lu (orig size = %zu)",
+ ftello(out), lte->output_resource_entry.original_size);
p = put_resource_entry(buf, <e->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("Failed to write lookup table entry: %m\n");
+ ERROR_WITH_ERRNO("Failed to write lookup table entry");
return WIMLIB_ERR_WRITE;
}
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) {
- 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)
{
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)
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;
}
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 *table, const u8 hash[])
+{
+ size_t i;
+ struct lookup_table_entry *lte;
+ struct hlist_node *pos;
+
+ 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;
+ return NULL;
}
+
+/*
+ * 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,
+ struct lookup_table_entry **lte_ret,
+ unsigned *stream_idx_ret)
+{
+ struct dentry *dentry;
+ struct lookup_table_entry *lte;
+ unsigned stream_idx;
+ dentry = get_dentry(w, path);
+ if (!dentry)
+ return -ENOENT;
+
+ wimlib_assert(dentry->resolved);
+
+ lte = dentry->lte;
+ if (!(lookup_flags & LOOKUP_FLAG_DIRECTORY_OK)
+ && dentry_is_directory(dentry))
+ 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;
+ }
+ }
+ return -ENOENT;
+ }
+ }
+out:
+ if (dentry_ret)
+ *dentry_ret = dentry;
+ if (lte_ret)
+ *lte_ret = lte;
+ if (stream_idx_ret)
+ *stream_idx_ret = stream_idx;
+ return 0;
+}
+
+/* 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;
+
+ 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, <e->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,
+ <e->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;
+ }
+ }
+ return 0;
+}
+
+struct lookup_table_entry *
+dentry_first_lte(const struct dentry *dentry, const struct lookup_table *table)
+{
+ if (dentry->resolved)
+ return dentry_first_lte_resolved(dentry);
+ else
+ return dentry_first_lte_unresolved(dentry, table);
+}
+
git://wimlib.net / wimlib / blobdiff