X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Flookup_table.c;h=67ce92a3f37b79617ac2a9c370e5980c0fe18f9a;hp=e6b8fb2cbafcc86ee033b9d4dd5b579e0b9886d3;hb=c92b18f7074e6d632c555bed5897c5723abde720;hpb=21a83b1b20f5ae138bc4bb9bdedd80a2a2d92c0a diff --git a/src/lookup_table.c b/src/lookup_table.c index e6b8fb2c..67ce92a3 100644 --- a/src/lookup_table.c +++ b/src/lookup_table.c @@ -11,72 +11,150 @@ * 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 "buffer_io.h" #include +#ifdef WITH_FUSE +#include +#endif + struct lookup_table *new_lookup_table(size_t capacity) { struct lookup_table *table; struct hlist_head *array; table = MALLOC(sizeof(struct lookup_table)); - if (!table) - goto err; - array = CALLOC(capacity, sizeof(array[0])); - if (!array) { - FREE(table); - goto err; + if (table) { + array = CALLOC(capacity, sizeof(array[0])); + if (array) { + table->num_entries = 0; + table->capacity = capacity; + table->array = array; + } else { + FREE(table); + table = NULL; + ERROR("Failed to allocate memory for lookup table with capacity %zu", + capacity); + } } - 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); - 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; - + lte = CALLOC(1, sizeof(struct lookup_table_entry)); - if (!lte) { + if (lte) { + lte->part_number = 1; + lte->refcnt = 1; + } else { ERROR("Out of memory (tried to allocate %zu bytes for " "lookup table entry)", sizeof(struct lookup_table_entry)); - return NULL; } - - lte->part_number = 1; - lte->refcnt = 1; - lte->wim = wim; - INIT_LIST_HEAD(<e->lte_group_list); return lte; } +struct lookup_table_entry * +clone_lookup_table_entry(const struct lookup_table_entry *old) +{ + struct lookup_table_entry *new; + + new = MALLOC(sizeof(*new)); + if (!new) + return NULL; + + memcpy(new, old, sizeof(*old)); + new->extracted_file = NULL; + switch (new->resource_location) { + case RESOURCE_IN_STAGING_FILE: + case RESOURCE_IN_FILE_ON_DISK: + wimlib_assert((void*)&old->file_on_disk == + (void*)&old->staging_file_name); + new->staging_file_name = STRDUP(old->staging_file_name); + if (!new->staging_file_name) + goto out_free; + break; + case RESOURCE_IN_ATTACHED_BUFFER: + new->attached_buffer = MALLOC(wim_resource_size(old)); + if (!new->attached_buffer) + goto out_free; + memcpy(new->attached_buffer, old->attached_buffer, + wim_resource_size(old)); + break; +#ifdef WITH_NTFS_3G + case RESOURCE_IN_NTFS_VOLUME: + if (old->ntfs_loc) { + struct ntfs_location *loc; + loc = MALLOC(sizeof(*loc)); + if (!loc) + goto out_free; + memcpy(loc, old->ntfs_loc, sizeof(*loc)); + loc->path_utf8 = NULL; + loc->stream_name_utf16 = NULL; + new->ntfs_loc = loc; + loc->path_utf8 = STRDUP(old->ntfs_loc->path_utf8); + if (!loc->path_utf8) + goto out_free; + loc->stream_name_utf16 = MALLOC(loc->stream_name_utf16_num_chars * 2); + if (!loc->stream_name_utf16) + goto out_free; + memcpy(loc->stream_name_utf16, + old->ntfs_loc->stream_name_utf16, + loc->stream_name_utf16_num_chars * 2); + } + break; +#endif + default: + break; + } + return new; +out_free: + free_lookup_table_entry(new); + return NULL; +} + void free_lookup_table_entry(struct lookup_table_entry *lte) { if (lte) { - if (lte->staging_list.next) - list_del(<e->staging_list); - FREE(lte->file_on_disk); + switch (lte->resource_location) { + case RESOURCE_IN_STAGING_FILE: + case RESOURCE_IN_ATTACHED_BUFFER: + case RESOURCE_IN_FILE_ON_DISK: + wimlib_assert(((void*)<e->file_on_disk == + (void*)<e->staging_file_name) + && ((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_utf8); + FREE(lte->ntfs_loc->stream_name_utf16); + FREE(lte->ntfs_loc); + } + break; +#endif + default: + break; + } FREE(lte); } } @@ -91,7 +169,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, @@ -109,7 +187,7 @@ void free_lookup_table(struct lookup_table *table) * @table: A pointer to the lookup table. * @entry: A pointer to the entry to insert. */ -void lookup_table_insert(struct lookup_table *table, +void lookup_table_insert(struct lookup_table *table, struct lookup_table_entry *lte) { size_t i = lte->hash_short % table->capacity; @@ -119,33 +197,53 @@ 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); + wimlib_assert(lte->staging_list.next); + wimlib_assert(lte->staging_list.prev); + list_del(<e->staging_list); + } + #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, * 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) +void lte_decrement_refcnt(struct lookup_table_entry *lte, + struct 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; - } - } + wimlib_assert(lte != NULL); + wimlib_assert(lte->refcnt != 0); + if (--lte->refcnt == 0) { + lookup_table_unlink(table, lte); + #ifdef WITH_FUSE + if (lte->num_opened_fds == 0) + #endif + finalize_lte(lte); } - return lte; } -/* +#ifdef WITH_FUSE +void lte_decrement_num_opened_fds(struct lookup_table_entry *lte) +{ + wimlib_assert(lte != NULL); + if (lte->num_opened_fds != 0) { + if (--lte->num_opened_fds == 0 && lte->refcnt == 0) + finalize_lte(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. */ -int for_lookup_table_entry(struct lookup_table *table, +int for_lookup_table_entry(struct lookup_table *table, int (*visitor)(struct lookup_table_entry *, void *), void *arg) { @@ -171,16 +269,24 @@ int for_lookup_table_entry(struct lookup_table *table, */ int read_lookup_table(WIMStruct *w) { - u64 num_entries; - u8 buf[WIM_LOOKUP_TABLE_ENTRY_DISK_SIZE]; - int ret; + u64 num_entries; + u8 buf[WIM_LOOKUP_TABLE_ENTRY_DISK_SIZE]; + int ret; struct lookup_table *table; + struct lookup_table_entry *cur_entry = NULL, *duplicate_entry; + + if (resource_is_compressed(&w->hdr.lookup_table_res_entry)) { + ERROR("Didn't expect a compressed lookup table!"); + ERROR("Ask the author to implement support for this."); + return WIMLIB_ERR_COMPRESSED_LOOKUP_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) { + 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); @@ -195,7 +301,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,30 +312,87 @@ 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; } 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); + + 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; + } + + /* Ordinarily, no two streams should share the same SHA1 message + * digest. However, this constraint can be broken for metadata + * resources--- two identical images will have the same metadata + * resource, but their lookup table entries are not shared. */ + duplicate_entry = __lookup_resource(table, cur_entry->hash); + if (duplicate_entry + && !((duplicate_entry->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) + && cur_entry->resource_entry.flags & WIM_RESHDR_FLAG_METADATA)) + { + 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; + } + if ((cur_entry->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) + && cur_entry->refcnt != 1) + { + ERROR("Found metadata resource with refcnt != 1:"); + 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; } -/* +/* * Writes a lookup table entry to the output file. */ int write_lookup_table_entry(struct lookup_table_entry *lte, void *__out) @@ -241,10 +403,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) @@ -265,25 +423,72 @@ int write_lookup_table_entry(struct lookup_table_entry *lte, void *__out) return 0; } +/* Writes the lookup table to the output file. */ +int write_lookup_table(struct lookup_table *table, FILE *out, + struct resource_entry *out_res_entry) +{ + off_t start_offset, end_offset; + int ret; + + start_offset = ftello(out); + if (start_offset == -1) + return WIMLIB_ERR_WRITE; + + ret = for_lookup_table_entry(table, write_lookup_table_entry, out); + if (ret != 0) + return ret; + + end_offset = ftello(out); + if (end_offset == -1) + return WIMLIB_ERR_WRITE; + + out_res_entry->offset = start_offset; + out_res_entry->size = end_offset - start_offset; + out_res_entry->original_size = end_offset - start_offset; + out_res_entry->flags = WIM_RESHDR_FLAG_METADATA; + + return 0; +} -int zero_out_refcnts(struct lookup_table_entry *entry, void *ignore) +int lte_zero_real_refcnt(struct lookup_table_entry *lte, void *ignore) { - entry->out_refcnt = 0; + lte->real_refcnt = 0; return 0; } -void print_lookup_table_entry(struct lookup_table_entry *lte) +int lte_zero_out_refcnt(struct lookup_table_entry *lte, void *ignore) +{ + lte->out_refcnt = 0; + return 0; +} + +int lte_zero_extracted_file(struct lookup_table_entry *lte, void *ignore) +{ + lte->extracted_file = NULL; + return 0; +} + +int lte_free_extracted_file(struct lookup_table_entry *lte, void *ignore) +{ + if (lte->extracted_file != NULL) { + FREE(lte->extracted_file); + lte->extracted_file = NULL; + } + return 0; +} + +void print_lookup_table_entry(const struct lookup_table_entry *lte) { if (!lte) { putchar('\n'); return; } - printf("Offset = %"PRIu64" bytes\n", + printf("Offset = %"PRIu64" bytes\n", lte->resource_entry.offset); - printf("Size = %"PRIu64" bytes\n", + printf("Size = %"PRIu64" bytes\n", (u64)lte->resource_entry.size); - printf("Original size = %"PRIu64" bytes\n", + 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); @@ -314,6 +519,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'); } @@ -326,16 +533,16 @@ static int do_print_lookup_table_entry(struct lookup_table_entry *lte, } /* - * Prints the lookup table of a WIM file. + * Prints the lookup table of a WIM file. */ WIMLIBAPI void wimlib_print_lookup_table(WIMStruct *w) { - for_lookup_table_entry(w->lookup_table, + for_lookup_table_entry(w->lookup_table, do_print_lookup_table_entry, NULL); } -/* +/* * Looks up an entry in the lookup table. */ struct lookup_table_entry * @@ -345,6 +552,9 @@ __lookup_resource(const struct lookup_table *table, const u8 hash[]) struct lookup_table_entry *lte; struct hlist_node *pos; + wimlib_assert(table != NULL); + wimlib_assert(hash != NULL); + i = *(size_t*)hash % table->capacity; hlist_for_each_entry(lte, pos, &table->array[i], hash_list) if (hashes_equal(hash, lte->hash)) @@ -352,48 +562,63 @@ __lookup_resource(const struct lookup_table *table, const u8 hash[]) return NULL; } -/* +#ifdef WITH_FUSE +/* * 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->d_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) @@ -404,8 +629,47 @@ out: *stream_idx_ret = stream_idx; return 0; } +#endif + +void inode_resolve_ltes(struct inode *inode, struct lookup_table *table) +{ + + if (!inode->resolved) { + struct lookup_table_entry *lte; + /* Resolve the default file stream */ + lte = __lookup_resource(table, inode->hash); + inode->lte = lte; + inode->resolved = 1; + + /* 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; + } + } +} + +void inode_unresolve_ltes(struct inode *inode) +{ + if (inode->resolved) { + if (inode->lte) + copy_hash(inode->hash, inode->lte->hash); + else + zero_out_hash(inode->hash); + + for (u16 i = 0; i < inode->num_ads; i++) { + if (inode->ads_entries[i].lte) + copy_hash(inode->ads_entries[i].hash, + inode->ads_entries[i].lte->hash); + else + zero_out_hash(inode->ads_entries[i].hash); + } + inode->resolved = 0; + } +} -/* Resolve a dentry's lookup table entries +/* 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 @@ -414,48 +678,73 @@ 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; + wimlib_assert(dentry->refcnt == 1); + inode_resolve_ltes(dentry->d_inode, table); + return 0; +} - if (dentry->resolved) - return 0; +int dentry_unresolve_ltes(struct dentry *dentry, void *ignore) +{ + inode_unresolve_ltes(dentry->d_inode); + 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); +/* + * Returns the lookup table entry for stream @stream_idx of the inode, where + * stream_idx = 0 means the default un-named file stream, and stream_idx >= 1 + * corresponds to an alternate data stream. + * + * This works for both resolved and un-resolved dentries. + */ +struct lookup_table_entry * +inode_stream_lte(const struct inode *inode, unsigned stream_idx, + const struct lookup_table *table) +{ + if (inode->resolved) + return inode_stream_lte_resolved(inode, stream_idx); 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; + return inode_stream_lte_unresolved(inode, stream_idx, table); } + +/* 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 more 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); } +static int lte_add_stream_size(struct lookup_table_entry *lte, + void *total_bytes_p) +{ + *(u64*)total_bytes_p += lte->resource_entry.size; + return 0; +} + +u64 lookup_table_total_stream_size(struct lookup_table *table) +{ + u64 total_size = 0; + for_lookup_table_entry(table, lte_add_stream_size, &total_size); + return total_size; +}