/*
* lookup_table.c
*
- * Lookup table, implemented as a hash table, that maps dentries to file
- * resources.
+ * Lookup table, implemented as a hash table, that maps SHA1 message digests to
+ * data streams; plus code to read and write the corresponding on-disk data.
*/
/*
- * Copyright (C) 2012 Eric Biggers
+ * Copyright (C) 2012, 2013 Eric Biggers
*
* 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 "wimlib_internal.h"
-#include "lookup_table.h"
-#include "io.h"
-#include <errno.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
-struct lookup_table *new_lookup_table(size_t capacity)
+#include "wimlib/assert.h"
+#include "wimlib/endianness.h"
+#include "wimlib/error.h"
+#include "wimlib/lookup_table.h"
+#include "wimlib/metadata.h"
+#include "wimlib/ntfs_3g.h"
+#include "wimlib/resource.h"
+#include "wimlib/util.h"
+#include "wimlib/write.h"
+
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h> /* for unlink() */
+
+/* WIM lookup table:
+ *
+ * This is a logical mapping from SHA1 message digests to the data streams
+ * contained in a WIM.
+ *
+ * Here it is implemented as a hash table.
+ *
+ * Note: Everything will break horribly if there is a SHA1 collision.
+ */
+struct wim_lookup_table {
+ struct hlist_head *array;
+ size_t num_entries;
+ size_t capacity;
+};
+
+struct wim_lookup_table *
+new_lookup_table(size_t capacity)
{
- struct lookup_table *table;
+ struct wim_lookup_table *table;
struct hlist_head *array;
- table = MALLOC(sizeof(struct lookup_table));
- if (!table)
- goto err;
+ table = MALLOC(sizeof(struct wim_lookup_table));
+ if (table == NULL)
+ goto oom;
+
array = CALLOC(capacity, sizeof(array[0]));
- if (!array) {
+ if (array == NULL) {
FREE(table);
- goto err;
+ goto oom;
}
+
table->num_entries = 0;
table->capacity = capacity;
table->array = array;
return table;
-err:
- ERROR("Failed to allocate memory for lookup table with capacity %zu",
- capacity);
+
+oom:
+ ERROR("Failed to allocate memory for lookup table "
+ "with capacity %zu", capacity);
return NULL;
}
-struct lookup_table_entry *new_lookup_table_entry(WIMStruct *wim)
+static int
+do_free_lookup_table_entry(struct wim_lookup_table_entry *entry, void *ignore)
{
- struct lookup_table_entry *lte;
-
- lte = CALLOC(1, sizeof(struct lookup_table_entry));
- if (!lte) {
- ERROR("Out of memory (tried to allocate %zu bytes for "
- "lookup table entry)",
- sizeof(struct lookup_table_entry));
- return NULL;
+ free_lookup_table_entry(entry);
+ return 0;
+}
+
+void
+free_lookup_table(struct wim_lookup_table *table)
+{
+ DEBUG("Freeing lookup table.");
+ if (table == NULL)
+ return;
+
+ if (table->array) {
+ for_lookup_table_entry(table,
+ do_free_lookup_table_entry,
+ NULL);
+ FREE(table->array);
}
+ FREE(table);
+}
+
+struct wim_lookup_table_entry *
+new_lookup_table_entry(void)
+{
+ struct wim_lookup_table_entry *lte;
+
+ lte = CALLOC(1, sizeof(struct wim_lookup_table_entry));
+ if (lte == NULL)
+ return NULL;
+
+ lte->refcnt = 1;
+
+ /* lte->resource_location = RESOURCE_NONEXISTENT */
+ BUILD_BUG_ON(RESOURCE_NONEXISTENT != 0);
- lte->part_number = 1;
- lte->refcnt = 1;
- lte->wim = wim;
- INIT_LIST_HEAD(<e->lte_group_list);
return lte;
}
-void free_lookup_table_entry(struct lookup_table_entry *lte)
+struct wim_lookup_table_entry *
+clone_lookup_table_entry(const struct wim_lookup_table_entry *old)
+{
+ struct wim_lookup_table_entry *new;
+
+ new = memdup(old, sizeof(struct wim_lookup_table_entry));
+ if (new == NULL)
+ return NULL;
+
+ new->extracted_file = NULL;
+ switch (new->resource_location) {
+ case RESOURCE_IN_WIM:
+ list_add(&new->rspec_node, &new->rspec->stream_list);
+ break;
+
+ case RESOURCE_IN_FILE_ON_DISK:
+#ifdef __WIN32__
+ case RESOURCE_WIN32_ENCRYPTED:
+#endif
+#ifdef WITH_FUSE
+ case RESOURCE_IN_STAGING_FILE:
+ BUILD_BUG_ON((void*)&old->file_on_disk !=
+ (void*)&old->staging_file_name);
+#endif
+ new->file_on_disk = TSTRDUP(old->file_on_disk);
+ if (new->file_on_disk == NULL)
+ goto out_free;
+ break;
+ case RESOURCE_IN_ATTACHED_BUFFER:
+ new->attached_buffer = memdup(old->attached_buffer, old->size);
+ if (new->attached_buffer == NULL)
+ goto out_free;
+ break;
+#ifdef WITH_NTFS_3G
+ case RESOURCE_IN_NTFS_VOLUME:
+ if (old->ntfs_loc) {
+ struct ntfs_location *loc;
+ loc = memdup(old->ntfs_loc, sizeof(struct ntfs_location));
+ if (loc == NULL)
+ goto out_free;
+ loc->path = NULL;
+ loc->stream_name = NULL;
+ new->ntfs_loc = loc;
+ loc->path = STRDUP(old->ntfs_loc->path);
+ if (loc->path == NULL)
+ goto out_free;
+ if (loc->stream_name_nchars != 0) {
+ loc->stream_name = memdup(old->ntfs_loc->stream_name,
+ loc->stream_name_nchars * 2);
+ if (loc->stream_name == NULL)
+ goto out_free;
+ }
+ }
+ break;
+#endif
+ default:
+ break;
+ }
+ return new;
+
+out_free:
+ free_lookup_table_entry(new);
+ return NULL;
+}
+
+void
+lte_put_resource(struct wim_lookup_table_entry *lte)
+{
+ switch (lte->resource_location) {
+ case RESOURCE_IN_WIM:
+ list_del(<e->rspec_node);
+ if (list_empty(<e->rspec->stream_list))
+ FREE(lte->rspec);
+ break;
+ case RESOURCE_IN_FILE_ON_DISK:
+#ifdef __WIN32__
+ case RESOURCE_WIN32_ENCRYPTED:
+#endif
+#ifdef WITH_FUSE
+ case RESOURCE_IN_STAGING_FILE:
+ BUILD_BUG_ON((void*)<e->file_on_disk !=
+ (void*)<e->staging_file_name);
+#endif
+ case RESOURCE_IN_ATTACHED_BUFFER:
+ BUILD_BUG_ON((void*)<e->file_on_disk !=
+ (void*)<e->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);
+ FREE(lte->ntfs_loc->stream_name);
+ FREE(lte->ntfs_loc);
+ }
+ break;
+#endif
+ default:
+ break;
+ }
+}
+
+void
+free_lookup_table_entry(struct wim_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);
+ lte_put_resource(lte);
FREE(lte);
}
}
-static int do_free_lookup_table_entry(struct lookup_table_entry *entry,
- void *ignore)
+/* Should this stream be retained even if it has no references? */
+static bool
+should_retain_lte(const struct wim_lookup_table_entry *lte)
{
- free_lookup_table_entry(entry);
- return 0;
+ return lte->resource_location == RESOURCE_IN_WIM;
}
-
-void free_lookup_table(struct lookup_table *table)
+static void
+finalize_lte(struct wim_lookup_table_entry *lte)
{
- 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);
- }
+ if (!should_retain_lte(lte))
+ free_lookup_table_entry(lte);
}
/*
- * Inserts an entry into the lookup table.
+ * Decrements the reference count for the lookup table entry @lte, which must be
+ * inserted in the stream lookup table @table.
*
- * @table: A pointer to the lookup table.
- * @entry: A pointer to the entry to insert.
+ * If the reference count reaches 0, this may cause @lte to be destroyed.
+ * However, we may retain entries with 0 reference count. This does not affect
+ * correctness, but it prevents the entries for valid streams in a WIM archive,
+ * which will continue to be present after appending to the file, from being
+ * lost merely because we dropped all references to them.
*/
-void lookup_table_insert(struct lookup_table *table,
- struct lookup_table_entry *lte)
+void
+lte_decrement_refcnt(struct wim_lookup_table_entry *lte,
+ struct wim_lookup_table *table)
{
- size_t i = lte->hash_short % table->capacity;
- hlist_add_head(<e->hash_list, &table->array[i]);
+ wimlib_assert(lte->refcnt != 0);
+
+ if (--lte->refcnt == 0) {
+ if (lte->unhashed) {
+ list_del(<e->unhashed_list);
+ #ifdef WITH_FUSE
+ /* If the stream has been extracted to a staging file
+ * for a FUSE mount, unlink the staging file. (Note
+ * that there still may be open file descriptors to it.)
+ * */
+ if (lte->resource_location == RESOURCE_IN_STAGING_FILE)
+ unlink(lte->staging_file_name);
+ #endif
+ } else {
+ if (!should_retain_lte(lte))
+ lookup_table_unlink(table, lte);
+ }
+
+ /* If FUSE mounts are enabled, we don't actually free the entry
+ * until the last file descriptor has been closed by
+ * lte_decrement_num_opened_fds(). */
+#ifdef WITH_FUSE
+ if (lte->num_opened_fds == 0)
+#endif
+ finalize_lte(lte);
+ }
+}
- /* XXX Make the table grow when too many entries have been inserted. */
- table->num_entries++;
+#ifdef WITH_FUSE
+void
+lte_decrement_num_opened_fds(struct wim_lookup_table_entry *lte)
+{
+ wimlib_assert(lte->num_opened_fds != 0);
+
+ if (--lte->num_opened_fds == 0 && lte->refcnt == 0)
+ finalize_lte(lte);
}
+#endif
+static void
+lookup_table_insert_raw(struct wim_lookup_table *table,
+ struct wim_lookup_table_entry *lte)
+{
+ size_t i = lte->hash_short % table->capacity;
+ hlist_add_head(<e->hash_list, &table->array[i]);
+}
-/* 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)
+static void
+enlarge_lookup_table(struct wim_lookup_table *table)
{
- 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;
- }
+ size_t old_capacity, new_capacity;
+ struct hlist_head *old_array, *new_array;
+ struct wim_lookup_table_entry *lte;
+ struct hlist_node *cur, *tmp;
+ size_t i;
+
+ old_capacity = table->capacity;
+ new_capacity = old_capacity * 2;
+ new_array = CALLOC(new_capacity, sizeof(struct hlist_head));
+ if (new_array == NULL)
+ return;
+ old_array = table->array;
+ table->array = new_array;
+ table->capacity = new_capacity;
+
+ for (i = 0; i < old_capacity; i++) {
+ hlist_for_each_entry_safe(lte, cur, tmp, &old_array[i], hash_list) {
+ hlist_del(<e->hash_list);
+ lookup_table_insert_raw(table, lte);
}
}
- return lte;
+ FREE(old_array);
}
-/*
- * Calls a function on all the entries in the lookup table. Stop early and
- * 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)
+/* Inserts an entry into the lookup table. */
+void
+lookup_table_insert(struct wim_lookup_table *table,
+ struct wim_lookup_table_entry *lte)
+{
+ lookup_table_insert_raw(table, lte);
+ if (++table->num_entries > table->capacity)
+ enlarge_lookup_table(table);
+}
+
+/* Unlinks a lookup table entry from the table; does not free it. */
+void
+lookup_table_unlink(struct wim_lookup_table *table,
+ struct wim_lookup_table_entry *lte)
+{
+ wimlib_assert(!lte->unhashed);
+ wimlib_assert(table->num_entries != 0);
+
+ hlist_del(<e->hash_list);
+ table->num_entries--;
+}
+
+/* Given a SHA1 message digest, return the corresponding entry in the WIM's
+ * lookup table, or NULL if there is none. */
+struct wim_lookup_table_entry *
+lookup_stream(const struct wim_lookup_table *table, const u8 hash[])
+{
+ size_t i;
+ struct wim_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;
+}
+
+/* Calls a function on all the entries in the WIM lookup table. Stop early and
+ * return nonzero if any call to the function returns nonzero. */
+int
+for_lookup_table_entry(struct wim_lookup_table *table,
+ int (*visitor)(struct wim_lookup_table_entry *, void *),
+ void *arg)
{
- struct lookup_table_entry *lte;
+ struct wim_lookup_table_entry *lte;
struct hlist_node *pos, *tmp;
int ret;
hash_list)
{
ret = visitor(lte, arg);
- if (ret != 0)
+ if (ret)
return ret;
}
}
return 0;
}
+/* qsort() callback that sorts streams (represented by `struct
+ * wim_lookup_table_entry's) into an order optimized for reading.
+ *
+ * Sorting is done primarily by resource location, then secondarily by a
+ * per-resource location order. For example, resources in WIM files are sorted
+ * primarily by part number, then secondarily by offset, as to implement optimal
+ * reading of either a standalone or split WIM. */
+static int
+cmp_streams_by_sequential_order(const void *p1, const void *p2)
+{
+ const struct wim_lookup_table_entry *lte1, *lte2;
+ int v;
+ WIMStruct *wim1, *wim2;
+
+ lte1 = *(const struct wim_lookup_table_entry**)p1;
+ lte2 = *(const struct wim_lookup_table_entry**)p2;
+
+ v = (int)lte1->resource_location - (int)lte2->resource_location;
+
+ /* Different resource locations? */
+ if (v)
+ return v;
+
+ switch (lte1->resource_location) {
+ case RESOURCE_IN_WIM:
+ wim1 = lte1->rspec->wim;
+ wim2 = lte2->rspec->wim;
+
+ /* Different (possibly split) WIMs? */
+ if (wim1 != wim2) {
+ v = memcmp(wim1->hdr.guid, wim2->hdr.guid, WIM_GID_LEN);
+ if (v)
+ return v;
+ }
+
+ /* Different part numbers in the same WIM? */
+ v = (int)wim1->hdr.part_number - (int)wim2->hdr.part_number;
+ if (v)
+ return v;
+
+ if (lte1->rspec->offset_in_wim != lte2->rspec->offset_in_wim)
+ return cmp_u64(lte1->rspec->offset_in_wim,
+ lte2->rspec->offset_in_wim);
+
+ return cmp_u64(lte1->offset_in_res, lte2->offset_in_res);
+
+ case RESOURCE_IN_FILE_ON_DISK:
+#ifdef WITH_FUSE
+ case RESOURCE_IN_STAGING_FILE:
+#endif
+#ifdef __WIN32__
+ case RESOURCE_WIN32_ENCRYPTED:
+#endif
+ /* Compare files by path: just a heuristic that will place files
+ * in the same directory next to each other. */
+ return tstrcmp(lte1->file_on_disk, lte2->file_on_disk);
+#ifdef WITH_NTFS_3G
+ case RESOURCE_IN_NTFS_VOLUME:
+ return tstrcmp(lte1->ntfs_loc->path, lte2->ntfs_loc->path);
+#endif
+ default:
+ /* No additional sorting order defined for this resource
+ * location (e.g. RESOURCE_IN_ATTACHED_BUFFER); simply compare
+ * everything equal to each other. */
+ return 0;
+ }
+}
+
+int
+sort_stream_list(struct list_head *stream_list,
+ size_t list_head_offset,
+ int (*compar)(const void *, const void*))
+{
+ struct list_head *cur;
+ struct wim_lookup_table_entry **array;
+ size_t i;
+ size_t array_size;
+ size_t num_streams = 0;
+
+ list_for_each(cur, stream_list)
+ num_streams++;
+
+ if (num_streams <= 1)
+ return 0;
+
+ array_size = num_streams * sizeof(array[0]);
+ array = MALLOC(array_size);
+ if (array == NULL)
+ return WIMLIB_ERR_NOMEM;
+
+ cur = stream_list->next;
+ for (i = 0; i < num_streams; i++) {
+ array[i] = (struct wim_lookup_table_entry*)((u8*)cur -
+ list_head_offset);
+ cur = cur->next;
+ }
+
+ qsort(array, num_streams, sizeof(array[0]), compar);
+
+ INIT_LIST_HEAD(stream_list);
+ for (i = 0; i < num_streams; i++) {
+ list_add_tail((struct list_head*)
+ ((u8*)array[i] + list_head_offset),
+ stream_list);
+ }
+ FREE(array);
+ return 0;
+}
+
+/* Sort the specified list of streams in an order optimized for reading. */
+int
+sort_stream_list_by_sequential_order(struct list_head *stream_list,
+ size_t list_head_offset)
+{
+ return sort_stream_list(stream_list, list_head_offset,
+ cmp_streams_by_sequential_order);
+}
+
+
+static int
+add_lte_to_array(struct wim_lookup_table_entry *lte,
+ void *_pp)
+{
+ struct wim_lookup_table_entry ***pp = _pp;
+ *(*pp)++ = lte;
+ return 0;
+}
+
+/* Iterate through the lookup table entries, but first sort them by stream
+ * offset in the WIM. Caution: this is intended to be used when the stream
+ * offset field has actually been set. */
+int
+for_lookup_table_entry_pos_sorted(struct wim_lookup_table *table,
+ int (*visitor)(struct wim_lookup_table_entry *,
+ void *),
+ void *arg)
+{
+ struct wim_lookup_table_entry **lte_array, **p;
+ size_t num_streams = table->num_entries;
+ int ret;
+
+ lte_array = MALLOC(num_streams * sizeof(lte_array[0]));
+ if (!lte_array)
+ return WIMLIB_ERR_NOMEM;
+ p = lte_array;
+ for_lookup_table_entry(table, add_lte_to_array, &p);
+
+ wimlib_assert(p == lte_array + num_streams);
+
+ qsort(lte_array, num_streams, sizeof(lte_array[0]),
+ cmp_streams_by_sequential_order);
+ ret = 0;
+ for (size_t i = 0; i < num_streams; i++) {
+ ret = visitor(lte_array[i], arg);
+ if (ret)
+ break;
+ }
+ FREE(lte_array);
+ return ret;
+}
+
+/* On-disk format of a WIM lookup table entry (stream entry). */
+struct wim_lookup_table_entry_disk {
+ /* Size, offset, and flags of the stream. */
+ struct wim_reshdr_disk reshdr;
+
+ /* Which part of the split WIM this stream is in; indexed from 1. */
+ le16 part_number;
+
+ /* Reference count of this stream over all WIM images. */
+ le32 refcnt;
+
+ /* SHA1 message digest of the uncompressed data of this stream, or
+ * optionally all zeroes if this stream is of zero length. */
+ u8 hash[SHA1_HASH_SIZE];
+} _packed_attribute;
+
+#define WIM_LOOKUP_TABLE_ENTRY_DISK_SIZE 50
+
+static int
+cmp_streams_by_offset_in_res(const void *p1, const void *p2)
+{
+ const struct wim_lookup_table_entry *lte1, *lte2;
+
+ lte1 = *(const struct wim_lookup_table_entry**)p1;
+ lte2 = *(const struct wim_lookup_table_entry**)p2;
+
+ return cmp_u64(lte1->offset_in_res, lte2->offset_in_res);
+}
+
+/* Validate the size and location of a WIM resource. */
+static int
+validate_resource(struct wim_resource_spec *rspec)
+{
+ struct wim_lookup_table_entry *lte;
+ bool out_of_order;
+ u64 expected_next_offset;
+ int ret;
+
+ /* Verify that the resource itself has a valid offset and size. */
+ if (rspec->offset_in_wim + rspec->size_in_wim < rspec->size_in_wim)
+ goto invalid_due_to_overflow;
+
+ /* Verify that each stream in the resource has a valid offset and size.
+ */
+ expected_next_offset = 0;
+ out_of_order = false;
+ list_for_each_entry(lte, &rspec->stream_list, rspec_node) {
+ if (lte->offset_in_res + lte->size < lte->size ||
+ lte->offset_in_res + lte->size > rspec->uncompressed_size)
+ goto invalid_due_to_overflow;
+
+ if (lte->offset_in_res >= expected_next_offset)
+ expected_next_offset = lte->offset_in_res + lte->size;
+ else
+ out_of_order = true;
+ }
+
+ /* If the streams were not located at strictly increasing positions (not
+ * allowing for overlap), sort them. Then make sure that none overlap.
+ */
+ if (out_of_order) {
+ ret = sort_stream_list(&rspec->stream_list,
+ offsetof(struct wim_lookup_table_entry,
+ rspec_node),
+ cmp_streams_by_offset_in_res);
+ if (ret)
+ return ret;
+
+ expected_next_offset = 0;
+ list_for_each_entry(lte, &rspec->stream_list, rspec_node) {
+ if (lte->offset_in_res >= expected_next_offset)
+ expected_next_offset = lte->offset_in_res + lte->size;
+ else
+ goto invalid_due_to_overlap;
+ }
+ }
+
+ return 0;
+
+invalid_due_to_overflow:
+ ERROR("Invalid resource entry (offset overflow)");
+ return WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY;
+
+invalid_due_to_overlap:
+ ERROR("Invalid resource entry (streams in packed resource overlap)");
+ return WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY;
+}
+
+/* Validate the resource, or free it if unused. */
+static int
+finish_resource(struct wim_resource_spec *rspec)
+{
+ if (!list_empty(&rspec->stream_list)) {
+ /* This resource contains at least one stream. */
+ return validate_resource(rspec);
+ } else {
+ /* No streams are in this resource. Get rid of it. */
+ FREE(rspec);
+ return 0;
+ }
+}
/*
- * Reads the lookup table from a WIM file.
+ * Reads the lookup table from a WIM file. Usually, each entry specifies a
+ * stream that the WIM file contains, along with its location and SHA1 message
+ * digest.
+ *
+ * Saves lookup table entries for non-metadata streams in a hash table (set to
+ * wim->lookup_table), and saves the metadata entry for each image in a special
+ * per-image location (the wim->image_metadata array).
+ *
+ * This works for both version WIM_VERSION_DEFAULT (68864) and version
+ * WIM_VERSION_PACKED_STREAMS (3584) WIMs.
+ *
+ * Possible return values:
+ * WIMLIB_ERR_SUCCESS (0)
+ * WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
+ * WIMLIB_ERR_NOMEM
+ *
+ * Or an error code caused by failure to read the lookup table from the WIM
+ * file.
*/
-int read_lookup_table(WIMStruct *w)
-{
- u64 num_entries;
- u8 buf[WIM_LOOKUP_TABLE_ENTRY_DISK_SIZE];
- int ret;
- struct lookup_table *table;
-
- 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(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;
- }
+int
+read_wim_lookup_table(WIMStruct *wim)
+{
+ int ret;
+ size_t num_entries;
+ void *buf = NULL;
+ struct wim_lookup_table *table = NULL;
+ struct wim_lookup_table_entry *cur_entry = NULL;
+ struct wim_resource_spec *cur_rspec = NULL;
+ size_t num_duplicate_entries = 0;
+ size_t num_wrong_part_entries = 0;
+ u32 image_index = 0;
+
+ DEBUG("Reading lookup table.");
+
+ /* Sanity check: lookup table entries are 50 bytes each. */
+ BUILD_BUG_ON(sizeof(struct wim_lookup_table_entry_disk) !=
+ WIM_LOOKUP_TABLE_ENTRY_DISK_SIZE);
+
+ /* Calculate the number of entries in the lookup table. */
+ num_entries = wim->hdr.lookup_table_reshdr.uncompressed_size /
+ sizeof(struct wim_lookup_table_entry_disk);
- num_entries = w->hdr.lookup_table_res_entry.original_size /
- WIM_LOOKUP_TABLE_ENTRY_DISK_SIZE;
+ /* Read the lookup table into a buffer. */
+ ret = wim_reshdr_to_data(&wim->hdr.lookup_table_reshdr, wim, &buf);
+ if (ret)
+ goto out;
+
+ /* Allocate a hash table to map SHA1 message digests into stream
+ * specifications. This is the in-memory "lookup table". */
table = new_lookup_table(num_entries * 2 + 1);
if (!table)
- return WIMLIB_ERR_NOMEM;
+ goto oom;
- while (num_entries--) {
- const u8 *p;
- struct lookup_table_entry *cur_entry, *duplicate_entry;
+ /* Allocate and initalize stream entries ('struct
+ * wim_lookup_table_entry's) from the raw lookup table buffer. Each of
+ * these entries will point to a 'struct wim_resource_spec' that
+ * describes the underlying resource. In WIMs with version number
+ * WIM_VERSION_PACKED_STREAMS, a resource may contain multiple streams.
+ */
+ for (size_t i = 0; i < num_entries; i++) {
+ const struct wim_lookup_table_entry_disk *disk_entry =
+ &((const struct wim_lookup_table_entry_disk*)buf)[i];
+ struct wim_reshdr reshdr;
+ u16 part_number;
- 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 "
- "table");
- }
- ret = WIMLIB_ERR_READ;
- goto out;
+ /* Get the resource header */
+ get_wim_reshdr(&disk_entry->reshdr, &reshdr);
+
+ DEBUG("reshdr: size_in_wim=%"PRIu64", "
+ "uncompressed_size=%"PRIu64", "
+ "offset_in_wim=%"PRIu64", "
+ "flags=0x%02x\n",
+ reshdr.size_in_wim, reshdr.uncompressed_size,
+ reshdr.offset_in_wim, reshdr.flags);
+
+ /* Ignore PACKED_STREAMS flag if it isn't supposed to be used in
+ * this WIM version */
+ if (wim->hdr.wim_version == WIM_VERSION_DEFAULT)
+ reshdr.flags &= ~WIM_RESHDR_FLAG_PACKED_STREAMS;
+
+ /* Allocate a 'struct wim_lookup_table_entry' */
+ cur_entry = new_lookup_table_entry();
+ if (!cur_entry)
+ goto oom;
+
+ /* Get the part number, reference count, and hash. */
+ part_number = le16_to_cpu(disk_entry->part_number);
+ cur_entry->refcnt = le32_to_cpu(disk_entry->refcnt);
+ copy_hash(cur_entry->hash, disk_entry->hash);
+
+ /* Verify that the part number matches that of the underlying
+ * WIM file. */
+ if (part_number != wim->hdr.part_number) {
+ num_wrong_part_entries++;
+ goto free_cur_entry_and_continue;
}
- cur_entry = new_lookup_table_entry(w);
- if (!cur_entry) {
- ret = WIMLIB_ERR_NOMEM;
- goto out;
+
+ /* If resource is uncompressed, check for (unexpected) size
+ * mismatch. */
+ if (!(reshdr.flags & (WIM_RESHDR_FLAG_PACKED_STREAMS |
+ WIM_RESHDR_FLAG_COMPRESSED))) {
+ if (reshdr.uncompressed_size != reshdr.size_in_wim) {
+ /* So ... This is an uncompressed resource, but
+ * its uncompressed size is NOT the same as its
+ * "compressed" size (size_in_wim). What to do
+ * with it?
+ *
+ * Based on a simple test, WIMGAPI seems to
+ * handle this as follows:
+ *
+ * if (size_in_wim > uncompressed_size) {
+ * Ignore uncompressed_size; use
+ * size_in_wim instead.
+ * } else {
+ * Honor uncompressed_size, but treat the
+ * part of the file data above size_in_wim
+ * as all zeros.
+ * }
+ *
+ * So we will do the same.
+ */
+ if (reshdr.size_in_wim > reshdr.uncompressed_size)
+ reshdr.uncompressed_size = reshdr.size_in_wim;
+ }
}
- 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, 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;
+
+ /*
+ * Possibly start a new resource.
+ *
+ * We need to start a new resource if:
+ *
+ * - There is no previous resource (cur_rspec).
+ *
+ * OR
+ *
+ * - The resource header did not have PACKED_STREAMS set, so it
+ * specifies a new, single-stream resource.
+ *
+ * OR
+ *
+ * - The resource header had PACKED_STREAMS set, and it's a
+ * special entry that specifies the resource itself as opposed
+ * to a stream, and we already encountered one such entry in
+ * the current resource. We will interpret this as the
+ * beginning of a new packed resource. (However, note that
+ * wimlib does not currently allow create WIMs with multiple
+ * packed resources, as to remain compatible with WIMGAPI.)
+ */
+ if (likely(!cur_rspec) ||
+ !(reshdr.flags & WIM_RESHDR_FLAG_PACKED_STREAMS) ||
+ (reshdr.uncompressed_size == WIM_PACK_MAGIC_NUMBER &&
+ cur_rspec->size_in_wim != 0))
+ {
+ /* Finish previous resource (if existent) */
+ if (cur_rspec) {
+ ret = finish_resource(cur_rspec);
+ cur_rspec = NULL;
+ if (ret)
+ goto out;
+ }
+
+ /* Allocate the resource specification and initialize it
+ * with values from the current stream entry. */
+ cur_rspec = MALLOC(sizeof(*cur_rspec));
+ if (!cur_rspec)
+ goto oom;
+
+ wim_res_hdr_to_spec(&reshdr, wim, cur_rspec);
+
+ /* If this is a packed run, the current stream entry may
+ * specify a stream within the resource, and not the
+ * resource itself. Zero possibly irrelevant data until
+ * it is read for certain. */
+ if (reshdr.flags & WIM_RESHDR_FLAG_PACKED_STREAMS) {
+ cur_rspec->size_in_wim = 0;
+ cur_rspec->uncompressed_size = 0;
+ cur_rspec->offset_in_wim = 0;
+ }
}
- 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))
+ /* Now cur_rspec != NULL. */
+
+ /* Checked for packed resource specification. */
+ if (unlikely((reshdr.flags & WIM_RESHDR_FLAG_PACKED_STREAMS) &&
+ reshdr.uncompressed_size == WIM_PACK_MAGIC_NUMBER))
{
- 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;
+ /* Found the specification for the packed resource.
+ * Transfer the values to the `struct
+ * wim_resource_spec', and discard the current stream
+ * since this lookup table entry did not, in fact,
+ * correspond to a "stream". */
+
+ /* The uncompressed size of the packed resource is
+ * actually stored in the header of the resource itself.
+ * Read it, and also grab the chunk size and compression
+ * type (which are not necessarily the defaults from the
+ * WIM header). */
+ struct alt_chunk_table_header_disk hdr;
+
+ ret = full_pread(&wim->in_fd, &hdr,
+ sizeof(hdr), reshdr.offset_in_wim);
+ if (ret)
+ goto out;
+
+ cur_rspec->uncompressed_size = le64_to_cpu(hdr.res_usize);
+ cur_rspec->offset_in_wim = reshdr.offset_in_wim;
+ cur_rspec->size_in_wim = reshdr.size_in_wim;
+ cur_rspec->flags = reshdr.flags;
+
+ /* Compression format numbers must be the same as in
+ * WIMGAPI to be compatible here. */
+ BUILD_BUG_ON(WIMLIB_COMPRESSION_TYPE_NONE != 0);
+ BUILD_BUG_ON(WIMLIB_COMPRESSION_TYPE_XPRESS != 1);
+ BUILD_BUG_ON(WIMLIB_COMPRESSION_TYPE_LZX != 2);
+ BUILD_BUG_ON(WIMLIB_COMPRESSION_TYPE_LZMS != 3);
+ cur_rspec->compression_type = le32_to_cpu(hdr.compression_format);
+
+ cur_rspec->chunk_size = le32_to_cpu(hdr.chunk_size);
+
+ DEBUG("Full pack is %"PRIu64" compressed bytes "
+ "at file offset %"PRIu64" (flags 0x%02x)",
+ cur_rspec->size_in_wim,
+ cur_rspec->offset_in_wim,
+ cur_rspec->flags);
+ goto free_cur_entry_and_continue;
}
+
+ /* Ignore entries with all zeroes in the hash field. */
+ if (is_zero_hash(cur_entry->hash))
+ goto free_cur_entry_and_continue;
+
+ if (reshdr.flags & WIM_RESHDR_FLAG_METADATA) {
+
+ /* Lookup table entry for a metadata resource. */
+
+ /* Metadata entries with no references must be ignored.
+ * See, for example, the WinPE WIMs from the WAIK v2.1.
+ */
+ if (cur_entry->refcnt == 0)
+ goto free_cur_entry_and_continue;
+
+ if (cur_entry->refcnt != 1) {
+ /* We don't currently support this case due to
+ * the complications of multiple images sharing
+ * the same metadata resource or a metadata
+ * resource also being referenced by files.
+ */
+ ERROR("Found metadata resource with refcnt != 1");
+ ret = WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY;
+ goto out;
+ }
+
+ if (wim->hdr.part_number != 1) {
+ WARNING("Ignoring metadata resource found in a "
+ "non-first part of the split WIM");
+ goto free_cur_entry_and_continue;
+ }
+
+ /* The number of entries in the lookup table with
+ * WIM_RESHDR_FLAG_METADATA set should be the same as
+ * the image_count field in the WIM header. */
+ if (image_index == wim->hdr.image_count) {
+ WARNING("Found more metadata resources than images");
+ goto free_cur_entry_and_continue;
+ }
+
+ /* Notice very carefully: We are assigning the metadata
+ * resources to images in the same order in which their
+ * lookup table entries occur on disk. (This is also
+ * the behavior of Microsoft's software.) In
+ * particular, this overrides the actual locations of
+ * the metadata resources themselves in the WIM file as
+ * well as any information written in the XML data. */
+ DEBUG("Found metadata resource for image %"PRIu32" at "
+ "offset %"PRIu64".",
+ image_index + 1,
+ reshdr.offset_in_wim);
+
+ wim->image_metadata[image_index++]->metadata_lte = cur_entry;
+ } else {
+ /* Lookup table entry for a non-metadata stream. */
+
+ /* Ignore this stream if it's a duplicate. */
+ if (lookup_stream(table, cur_entry->hash)) {
+ num_duplicate_entries++;
+ goto free_cur_entry_and_continue;
+ }
+
+ /* Insert the stream into the in-memory lookup table,
+ * keyed by its SHA1 message digest. */
+ lookup_table_insert(table, cur_entry);
+ }
+
+ /* Add the stream to the current resource specification. */
+ lte_bind_wim_resource_spec(cur_entry, cur_rspec);
+ if (reshdr.flags & WIM_RESHDR_FLAG_PACKED_STREAMS) {
+ /* In packed runs, the offset field is used for
+ * in-resource offset, not the in-WIM offset, and the
+ * size field is used for the uncompressed size, not the
+ * compressed size. */
+ cur_entry->offset_in_res = reshdr.offset_in_wim;
+ cur_entry->size = reshdr.size_in_wim;
+ cur_entry->flags = reshdr.flags;
+ /* cur_rspec stays the same */
+
+ } else {
+ /* Normal case: The stream corresponds one-to-one with
+ * the resource entry. */
+ cur_entry->offset_in_res = 0;
+ cur_entry->size = reshdr.uncompressed_size;
+ cur_entry->flags = reshdr.flags;
+ cur_rspec = NULL;
+ }
+ continue;
+
+ free_cur_entry_and_continue:
+ free_lookup_table_entry(cur_entry);
+ }
+ cur_entry = NULL;
+
+ /* Validate the last resource. */
+ if (cur_rspec) {
+ ret = finish_resource(cur_rspec);
+ cur_rspec = NULL;
+ if (ret)
+ goto out;
+ }
+
+ if (wim->hdr.part_number == 1 && image_index != wim->hdr.image_count) {
+ WARNING("Could not find metadata resources for all images");
+ for (u32 i = image_index; i < wim->hdr.image_count; i++)
+ put_image_metadata(wim->image_metadata[i], NULL);
+ wim->hdr.image_count = image_index;
}
+
+ if (num_duplicate_entries > 0) {
+ WARNING("Ignoring %zu duplicate streams in the WIM lookup table",
+ num_duplicate_entries);
+ }
+
+ if (num_wrong_part_entries > 0) {
+ WARNING("Ignoring %zu streams with wrong part number",
+ num_wrong_part_entries);
+ }
+
DEBUG("Done reading lookup table.");
- w->lookup_table = table;
- return 0;
+ wim->lookup_table = table;
+ table = NULL;
+ ret = 0;
+ goto out;
+oom:
+ ERROR("Not enough memory to read lookup table!");
+ ret = WIMLIB_ERR_NOMEM;
out:
+ if (cur_rspec && list_empty(&cur_rspec->stream_list))
+ FREE(cur_rspec);
+ free_lookup_table_entry(cur_entry);
free_lookup_table(table);
+ FREE(buf);
return ret;
}
+static void
+put_wim_lookup_table_entry(struct wim_lookup_table_entry_disk *disk_entry,
+ const struct wim_reshdr *out_reshdr,
+ u16 part_number, u32 refcnt, const u8 *hash)
+{
+ put_wim_reshdr(out_reshdr, &disk_entry->reshdr);
+ disk_entry->part_number = cpu_to_le16(part_number);
+ disk_entry->refcnt = cpu_to_le32(refcnt);
+ copy_hash(disk_entry->hash, hash);
+}
-/*
- * Writes a lookup table entry to the output file.
- */
-int write_lookup_table_entry(struct lookup_table_entry *lte, void *__out)
+int
+write_wim_lookup_table_from_stream_list(struct list_head *stream_list,
+ struct filedes *out_fd,
+ u16 part_number,
+ struct wim_reshdr *out_reshdr,
+ int write_resource_flags)
{
- FILE *out;
- u8 buf[WIM_LOOKUP_TABLE_ENTRY_DISK_SIZE];
- u8 *p;
+ size_t table_size;
+ struct wim_lookup_table_entry *lte;
+ struct wim_lookup_table_entry_disk *table_buf;
+ struct wim_lookup_table_entry_disk *table_buf_ptr;
+ int ret;
+ u64 prev_res_offset_in_wim = ~0ULL;
- out = __out;
+ table_size = 0;
+ list_for_each_entry(lte, stream_list, lookup_table_list) {
+ table_size += sizeof(struct wim_lookup_table_entry_disk);
- /* do not write lookup table entries for empty files */
- if (lte->output_resource_entry.original_size == 0)
- return 0;
+ if (lte->out_reshdr.flags & WIM_RESHDR_FLAG_PACKED_STREAMS &&
+ lte->out_res_offset_in_wim != prev_res_offset_in_wim)
+ {
+ table_size += sizeof(struct wim_lookup_table_entry_disk);
+ prev_res_offset_in_wim = lte->out_res_offset_in_wim;
+ }
+ }
- /* Don't write entries that have not had file resources or metadata
- * resources written for them. */
- if (lte->out_refcnt == 0)
- return 0;
+ DEBUG("Writing WIM lookup table (size=%zu, offset=%"PRIu64")",
+ table_size, out_fd->offset);
- 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, 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;
+ table_buf = MALLOC(table_size);
+ if (table_buf == NULL) {
+ ERROR("Failed to allocate %zu bytes for temporary lookup table",
+ table_size);
+ return WIMLIB_ERR_NOMEM;
}
- return 0;
-}
+ table_buf_ptr = table_buf;
+ prev_res_offset_in_wim = ~0ULL;
+ list_for_each_entry(lte, stream_list, lookup_table_list) {
+ put_wim_lookup_table_entry(table_buf_ptr++,
+ <e->out_reshdr,
+ part_number,
+ lte->out_refcnt,
+ lte->hash);
+ if (lte->out_reshdr.flags & WIM_RESHDR_FLAG_PACKED_STREAMS &&
+ lte->out_res_offset_in_wim != prev_res_offset_in_wim)
+ {
+ /* Put the main resource entry for the pack. */
-int zero_out_refcnts(struct lookup_table_entry *entry, void *ignore)
-{
- entry->out_refcnt = 0;
- return 0;
-}
+ struct wim_reshdr reshdr;
-void print_lookup_table_entry(const struct lookup_table_entry *lte)
-{
- if (!lte) {
- putchar('\n');
- return;
- }
- printf("Offset = %"PRIu64" bytes\n",
- lte->resource_entry.offset);
- printf("Size = %"PRIu64" bytes\n",
- (u64)lte->resource_entry.size);
- printf("Original size = %"PRIu64" bytes\n",
- 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 = lte->resource_entry.flags;
- if (flags & WIM_RESHDR_FLAG_COMPRESSED)
- fputs("WIM_RESHDR_FLAG_COMPRESSED, ", stdout);
- if (flags & WIM_RESHDR_FLAG_FREE)
- fputs("WIM_RESHDR_FLAG_FREE, ", stdout);
- if (flags & WIM_RESHDR_FLAG_METADATA)
- fputs("WIM_RESHDR_FLAG_METADATA, ", stdout);
- if (flags & WIM_RESHDR_FLAG_SPANNED)
- fputs("WIM_RESHDR_FLAG_SPANNED, ", stdout);
- putchar('\n');
- switch (lte->resource_location) {
- case RESOURCE_IN_WIM:
- if (lte->wim->filename) {
- printf("WIM file = `%s'\n",
- lte->wim->filename);
+ reshdr.offset_in_wim = lte->out_res_offset_in_wim;
+ reshdr.size_in_wim = lte->out_res_size_in_wim;
+ reshdr.uncompressed_size = WIM_PACK_MAGIC_NUMBER;
+ reshdr.flags = WIM_RESHDR_FLAG_PACKED_STREAMS;
+
+ DEBUG("Putting main entry for pack: "
+ "size_in_wim=%"PRIu64", "
+ "offset_in_wim=%"PRIu64", "
+ "uncompressed_size=%"PRIu64,
+ reshdr.size_in_wim,
+ reshdr.offset_in_wim,
+ reshdr.uncompressed_size);
+
+ put_wim_lookup_table_entry(table_buf_ptr++,
+ &reshdr,
+ part_number,
+ 1, zero_hash);
+ prev_res_offset_in_wim = lte->out_res_offset_in_wim;
}
- 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');
+ wimlib_assert((u8*)table_buf_ptr - (u8*)table_buf == table_size);
+
+ /* Write the lookup table uncompressed. Although wimlib can handle a
+ * compressed lookup table, MS software cannot. */
+ ret = write_wim_resource_from_buffer(table_buf,
+ table_size,
+ WIM_RESHDR_FLAG_METADATA,
+ out_fd,
+ WIMLIB_COMPRESSION_TYPE_NONE,
+ 0,
+ out_reshdr,
+ NULL,
+ write_resource_flags);
+ FREE(table_buf);
+ DEBUG("ret=%d", ret);
+ return ret;
}
-static int do_print_lookup_table_entry(struct lookup_table_entry *lte,
- void *ignore)
+int
+lte_zero_real_refcnt(struct wim_lookup_table_entry *lte, void *_ignore)
{
- print_lookup_table_entry(lte);
+ lte->real_refcnt = 0;
return 0;
}
-/*
- * Prints the lookup table of a WIM file.
- */
-WIMLIBAPI void wimlib_print_lookup_table(WIMStruct *w)
+int
+lte_zero_out_refcnt(struct wim_lookup_table_entry *lte, void *_ignore)
{
- for_lookup_table_entry(w->lookup_table,
- do_print_lookup_table_entry,
- NULL);
+ lte->out_refcnt = 0;
+ return 0;
}
-/*
- * Looks up an entry in the lookup table.
- */
-struct lookup_table_entry *
-__lookup_resource(const struct lookup_table *table, const u8 hash[])
+int
+lte_free_extracted_file(struct wim_lookup_table_entry *lte, void *_ignore)
{
- 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;
+ if (lte->extracted_file != NULL) {
+ FREE(lte->extracted_file);
+ lte->extracted_file = NULL;
+ }
+ return 0;
}
-/*
- * 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;
+/* Allocate a stream entry for the contents of the buffer, or re-use an existing
+ * entry in @lookup_table for the same stream. */
+struct wim_lookup_table_entry *
+new_stream_from_data_buffer(const void *buffer, size_t size,
+ struct wim_lookup_table *lookup_table)
+{
+ u8 hash[SHA1_HASH_SIZE];
+ struct wim_lookup_table_entry *lte, *existing_lte;
+
+ sha1_buffer(buffer, size, hash);
+ existing_lte = lookup_stream(lookup_table, hash);
+ if (existing_lte) {
+ wimlib_assert(existing_lte->size == size);
+ lte = existing_lte;
+ lte->refcnt++;
+ } else {
+ void *buffer_copy;
+ lte = new_lookup_table_entry();
+ if (lte == NULL)
+ return NULL;
+ buffer_copy = memdup(buffer, size);
+ if (buffer_copy == NULL) {
+ free_lookup_table_entry(lte);
+ return NULL;
}
+ lte->resource_location = RESOURCE_IN_ATTACHED_BUFFER;
+ lte->attached_buffer = buffer_copy;
+ lte->size = size;
+ copy_hash(lte->hash, hash);
+ lookup_table_insert(lookup_table, lte);
}
-out:
- if (dentry_ret)
- *dentry_ret = dentry;
- if (lte_ret)
- *lte_ret = lte;
- if (stream_idx_ret)
- *stream_idx_ret = stream_idx;
- return 0;
+ return lte;
}
-/* Resolve a dentry's lookup table entries
+/* Calculate the SHA1 message digest of a stream and move it from the list of
+ * unhashed streams to the stream lookup table, possibly joining it with an
+ * existing lookup table entry for an identical stream.
*
- * 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.
+ * @lte: An unhashed lookup table entry.
+ * @lookup_table: Lookup table for the WIM.
+ * @lte_ret: On success, write a pointer to the resulting lookup table
+ * entry to this location. This will be the same as @lte
+ * if it was inserted into the lookup table, or different if
+ * a duplicate stream was found.
*
- * This function always succeeds; unresolved lookup table entries are given a
- * NULL pointer.
+ * Returns 0 on success; nonzero if there is an error reading the stream.
*/
-int dentry_resolve_ltes(struct dentry *dentry, void *__table)
+int
+hash_unhashed_stream(struct wim_lookup_table_entry *lte,
+ struct wim_lookup_table *lookup_table,
+ struct wim_lookup_table_entry **lte_ret)
{
- struct lookup_table *table = __table;
- struct lookup_table_entry *lte;
+ int ret;
+ struct wim_lookup_table_entry *duplicate_lte;
+ struct wim_lookup_table_entry **back_ptr;
- if (dentry->resolved)
- return 0;
+ wimlib_assert(lte->unhashed);
- /* 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;
- }
+ /* back_ptr must be saved because @back_inode and @back_stream_id are in
+ * union with the SHA1 message digest and will no longer be valid once
+ * the SHA1 has been calculated. */
+ back_ptr = retrieve_lte_pointer(lte);
+
+ ret = sha1_stream(lte);
+ if (ret)
+ return ret;
+
+ /* Look for a duplicate stream */
+ duplicate_lte = lookup_stream(lookup_table, lte->hash);
+ list_del(<e->unhashed_list);
+ if (duplicate_lte) {
+ /* We have a duplicate stream. Transfer the reference counts
+ * from this stream to the duplicate and update the reference to
+ * this stream (in an inode or ads_entry) to point to the
+ * duplicate. The caller is responsible for freeing @lte if
+ * needed. */
+ wimlib_assert(!(duplicate_lte->unhashed));
+ wimlib_assert(duplicate_lte->size == lte->size);
+ duplicate_lte->refcnt += lte->refcnt;
+ lte->refcnt = 0;
+ *back_ptr = duplicate_lte;
+ lte = duplicate_lte;
+ } else {
+ /* No duplicate stream, so we need to insert this stream into
+ * the lookup table and treat it as a hashed stream. */
+ lookup_table_insert(lookup_table, lte);
+ lte->unhashed = 0;
}
+ *lte_ret = lte;
return 0;
}
-struct lookup_table_entry *
-dentry_first_lte(const struct dentry *dentry, const struct lookup_table *table)
+void
+lte_to_wimlib_resource_entry(const struct wim_lookup_table_entry *lte,
+ struct wimlib_resource_entry *wentry)
+{
+ memset(wentry, 0, sizeof(*wentry));
+
+ wentry->uncompressed_size = lte->size;
+ if (lte->resource_location == RESOURCE_IN_WIM) {
+ wentry->part_number = lte->rspec->wim->hdr.part_number;
+ if (lte->flags & WIM_RESHDR_FLAG_PACKED_STREAMS) {
+ wentry->compressed_size = 0;
+ wentry->offset = lte->offset_in_res;
+ } else {
+ wentry->compressed_size = lte->rspec->size_in_wim;
+ wentry->offset = lte->rspec->offset_in_wim;
+ }
+ wentry->raw_resource_offset_in_wim = lte->rspec->offset_in_wim;
+ /*wentry->raw_resource_uncompressed_size = lte->rspec->uncompressed_size;*/
+ wentry->raw_resource_compressed_size = lte->rspec->size_in_wim;
+ }
+ copy_hash(wentry->sha1_hash, lte->hash);
+ wentry->reference_count = lte->refcnt;
+ wentry->is_compressed = (lte->flags & WIM_RESHDR_FLAG_COMPRESSED) != 0;
+ wentry->is_metadata = (lte->flags & WIM_RESHDR_FLAG_METADATA) != 0;
+ wentry->is_free = (lte->flags & WIM_RESHDR_FLAG_FREE) != 0;
+ wentry->is_spanned = (lte->flags & WIM_RESHDR_FLAG_SPANNED) != 0;
+ wentry->packed = (lte->flags & WIM_RESHDR_FLAG_PACKED_STREAMS) != 0;
+}
+
+struct iterate_lte_context {
+ wimlib_iterate_lookup_table_callback_t cb;
+ void *user_ctx;
+};
+
+static int
+do_iterate_lte(struct wim_lookup_table_entry *lte, void *_ctx)
{
- if (dentry->resolved)
- return dentry_first_lte_resolved(dentry);
- else
- return dentry_first_lte_unresolved(dentry, table);
+ struct iterate_lte_context *ctx = _ctx;
+ struct wimlib_resource_entry entry;
+
+ lte_to_wimlib_resource_entry(lte, &entry);
+ return (*ctx->cb)(&entry, ctx->user_ctx);
}
+/* API function documented in wimlib.h */
+WIMLIBAPI int
+wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
+ wimlib_iterate_lookup_table_callback_t cb,
+ void *user_ctx)
+{
+ if (flags != 0)
+ return WIMLIB_ERR_INVALID_PARAM;
+
+ struct iterate_lte_context ctx = {
+ .cb = cb,
+ .user_ctx = user_ctx,
+ };
+ if (wim->hdr.part_number == 1) {
+ int ret;
+ for (int i = 0; i < wim->hdr.image_count; i++) {
+ ret = do_iterate_lte(wim->image_metadata[i]->metadata_lte,
+ &ctx);
+ if (ret)
+ return ret;
+ }
+ }
+ return for_lookup_table_entry(wim->lookup_table, do_iterate_lte, &ctx);
+}