X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Flookup_table.c;h=1c9f0529bc99076887abeebffd06e00c8e5df331;hp=142e7e0472f046cb8708faca88e61451d9b28c62;hb=b78b15e68de3c3f9a6aed5d3514e86a72cc9c9b1;hpb=d0e7f039e4ab206b9fd973c983e3fb841fcd2bf2 diff --git a/src/lookup_table.c b/src/lookup_table.c index 142e7e04..1c9f0529 100644 --- a/src/lookup_table.c +++ b/src/lookup_table.c @@ -1,8 +1,8 @@ /* * 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. */ /* @@ -26,56 +26,56 @@ #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 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; - array = CALLOC(capacity, sizeof(array[0])); - if (!array) { - FREE(table); - goto err; + table = MALLOC(sizeof(struct wim_lookup_table)); + 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() +struct wim_lookup_table_entry * +new_lookup_table_entry() { - struct lookup_table_entry *lte; + struct wim_lookup_table_entry *lte; - lte = CALLOC(1, sizeof(struct lookup_table_entry)); + lte = CALLOC(1, sizeof(struct wim_lookup_table_entry)); 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)); + sizeof(struct wim_lookup_table_entry)); } return lte; } -struct lookup_table_entry * -clone_lookup_table_entry(const struct lookup_table_entry *old) +struct wim_lookup_table_entry * +clone_lookup_table_entry(const struct wim_lookup_table_entry *old) { - struct lookup_table_entry *new; + struct wim_lookup_table_entry *new; new = MALLOC(sizeof(*new)); if (!new) @@ -86,8 +86,8 @@ clone_lookup_table_entry(const struct lookup_table_entry *old) 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); + BUILD_BUG_ON((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; @@ -99,6 +99,7 @@ clone_lookup_table_entry(const struct lookup_table_entry *old) 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; @@ -120,6 +121,9 @@ clone_lookup_table_entry(const struct lookup_table_entry *old) loc->stream_name_utf16_num_chars * 2); } break; +#endif + default: + break; } return new; out_free: @@ -127,17 +131,17 @@ out_free: return NULL; } -void free_lookup_table_entry(struct lookup_table_entry *lte) +void free_lookup_table_entry(struct wim_lookup_table_entry *lte) { if (lte) { 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)); + BUILD_BUG_ON((void*)<e->file_on_disk != + (void*)<e->staging_file_name); + BUILD_BUG_ON((void*)<e->file_on_disk != + (void*)<e->attached_buffer); FREE(lte->file_on_disk); break; #ifdef WITH_NTFS_3G @@ -152,12 +156,11 @@ void free_lookup_table_entry(struct lookup_table_entry *lte) default: break; } - FREE(lte->extracted_file); FREE(lte); } } -static int do_free_lookup_table_entry(struct lookup_table_entry *entry, +static int do_free_lookup_table_entry(struct wim_lookup_table_entry *entry, void *ignore) { free_lookup_table_entry(entry); @@ -165,7 +168,7 @@ static int do_free_lookup_table_entry(struct lookup_table_entry *entry, } -void free_lookup_table(struct lookup_table *table) +void free_lookup_table(struct wim_lookup_table *table) { DEBUG2("Freeing lookup table"); if (table) { @@ -183,10 +186,10 @@ void free_lookup_table(struct lookup_table *table) * Inserts an entry into the lookup table. * * @table: A pointer to the lookup table. - * @entry: A pointer to the entry to insert. + * @lte: A pointer to the entry to insert. */ -void lookup_table_insert(struct lookup_table *table, - struct lookup_table_entry *lte) +void lookup_table_insert(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]); @@ -195,13 +198,11 @@ void lookup_table_insert(struct lookup_table *table, table->num_entries++; } -static void finalize_lte(struct lookup_table_entry *lte) +static void finalize_lte(struct wim_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 @@ -212,11 +213,11 @@ static void finalize_lte(struct lookup_table_entry *lte) * 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. */ -void lte_decrement_refcnt(struct lookup_table_entry *lte, - struct lookup_table *table) +void lte_decrement_refcnt(struct wim_lookup_table_entry *lte, + struct wim_lookup_table *table) { - wimlib_assert(lte); - wimlib_assert(lte->refcnt); + wimlib_assert(lte != NULL); + wimlib_assert(lte->refcnt != 0); if (--lte->refcnt == 0) { lookup_table_unlink(table, lte); #ifdef WITH_FUSE @@ -227,25 +228,21 @@ void lte_decrement_refcnt(struct lookup_table_entry *lte, } #ifdef WITH_FUSE -void lte_decrement_num_opened_fds(struct lookup_table_entry *lte, - struct lookup_table *table) +void lte_decrement_num_opened_fds(struct wim_lookup_table_entry *lte) { - wimlib_assert(lte); - wimlib_assert(lte->num_opened_fds); - if (--lte->num_opened_fds == 0 && lte->refcnt == 0) - finalize_lte(lte); + 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 (*visitor)(struct lookup_table_entry *, void *), +/* 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; @@ -267,11 +264,17 @@ 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; - struct lookup_table *table; - struct lookup_table_entry *cur_entry = NULL, *duplicate_entry; + u64 num_entries; + u8 buf[WIM_LOOKUP_TABLE_ENTRY_DISK_SIZE]; + int ret; + struct wim_lookup_table *table; + struct wim_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, @@ -332,14 +335,23 @@ int read_lookup_table(WIMStruct *w) 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) { + if (duplicate_entry + && !((duplicate_entry->resource_entry.flags & WIM_RESHDR_FLAG_METADATA) + && cur_entry->resource_entry.flags & WIM_RESHDR_FLAG_METADATA)) + { + #ifdef ENABLE_ERROR_MESSAGES 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); + print_lookup_table_entry(duplicate_entry, stderr); ERROR("The second entry is:"); - print_lookup_table_entry(cur_entry); + print_lookup_table_entry(cur_entry, stderr); + #endif ret = WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY; goto out_free_cur_entry; } @@ -348,10 +360,22 @@ int read_lookup_table(WIMStruct *w) && (cur_entry->resource_entry.size != cur_entry->resource_entry.original_size)) { + #ifdef ENABLE_ERROR_MESSAGES 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); + print_lookup_table_entry(cur_entry, stderr); + #endif + 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) + { + #ifdef ENABLE_ERROR_MESSAGES + ERROR("Found metadata resource with refcnt != 1:"); + print_lookup_table_entry(cur_entry, stderr); + #endif ret = WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY; goto out_free_cur_entry; } @@ -372,7 +396,7 @@ out: /* * Writes a lookup table entry to the output file. */ -int write_lookup_table_entry(struct lookup_table_entry *lte, void *__out) +int write_lookup_table_entry(struct wim_lookup_table_entry *lte, void *__out) { FILE *out; u8 buf[WIM_LOOKUP_TABLE_ENTRY_DISK_SIZE]; @@ -385,9 +409,11 @@ int write_lookup_table_entry(struct lookup_table_entry *lte, void *__out) if (lte->out_refcnt == 0) return 0; - if (lte->output_resource_entry.flags & WIM_RESHDR_FLAG_METADATA) - DEBUG("Writing metadata entry at %lu (orig size = %zu)", + if (lte->output_resource_entry.flags & WIM_RESHDR_FLAG_METADATA) { + DEBUG("Writing metadata entry at %"PRIu64" " + "(orig size = %"PRIu64")", ftello(out), lte->output_resource_entry.original_size); + } p = put_resource_entry(buf, <e->output_resource_entry); p = put_u16(p, lte->part_number); @@ -400,77 +426,107 @@ 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 wim_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 lte_zero_real_refcnt(struct lookup_table_entry *lte, void *ignore) +int lte_zero_real_refcnt(struct wim_lookup_table_entry *lte, void *ignore) { lte->real_refcnt = 0; return 0; } -int lte_zero_out_refcnt(struct lookup_table_entry *lte, void *ignore) +int lte_zero_out_refcnt(struct wim_lookup_table_entry *lte, void *ignore) { lte->out_refcnt = 0; return 0; } -int lte_free_extracted_file(struct lookup_table_entry *lte, void *ignone) +int lte_free_extracted_file(struct wim_lookup_table_entry *lte, void *ignore) { - FREE(lte->extracted_file); - lte->extracted_file = NULL; + 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) +void print_lookup_table_entry(const struct wim_lookup_table_entry *lte, + FILE *out) { if (!lte) { - putchar('\n'); + putc('\n', out); return; } - printf("Offset = %"PRIu64" bytes\n", + fprintf(out, "Offset = %"PRIu64" bytes\n", lte->resource_entry.offset); - printf("Size = %"PRIu64" bytes\n", + fprintf(out, "Size = %"PRIu64" bytes\n", (u64)lte->resource_entry.size); - printf("Original size = %"PRIu64" bytes\n", + fprintf(out, "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"); + fprintf(out, "Part Number = %hu\n", lte->part_number); + fprintf(out, "Reference Count = %u\n", lte->refcnt); + fprintf(out, "Hash = 0x"); print_hash(lte->hash); - putchar('\n'); - printf("Flags = "); + putc('\n', out); + fprintf(out, "Flags = "); u8 flags = lte->resource_entry.flags; if (flags & WIM_RESHDR_FLAG_COMPRESSED) - fputs("WIM_RESHDR_FLAG_COMPRESSED, ", stdout); + fputs("WIM_RESHDR_FLAG_COMPRESSED, ", out); if (flags & WIM_RESHDR_FLAG_FREE) - fputs("WIM_RESHDR_FLAG_FREE, ", stdout); + fputs("WIM_RESHDR_FLAG_FREE, ", out); if (flags & WIM_RESHDR_FLAG_METADATA) - fputs("WIM_RESHDR_FLAG_METADATA, ", stdout); + fputs("WIM_RESHDR_FLAG_METADATA, ", out); if (flags & WIM_RESHDR_FLAG_SPANNED) - fputs("WIM_RESHDR_FLAG_SPANNED, ", stdout); - putchar('\n'); + fputs("WIM_RESHDR_FLAG_SPANNED, ", out); + putc('\n', out); switch (lte->resource_location) { case RESOURCE_IN_WIM: if (lte->wim->filename) { - printf("WIM file = `%s'\n", + fprintf(out, "WIM file = `%s'\n", lte->wim->filename); } break; case RESOURCE_IN_FILE_ON_DISK: - printf("File on Disk = `%s'\n", lte->file_on_disk); + fprintf(out, "File on Disk = `%s'\n", lte->file_on_disk); break; case RESOURCE_IN_STAGING_FILE: - printf("Staging File = `%s'\n", lte->staging_file_name); + fprintf(out, "Staging File = `%s'\n", lte->staging_file_name); break; default: break; } - putchar('\n'); + putc('\n', out); } -static int do_print_lookup_table_entry(struct lookup_table_entry *lte, - void *ignore) +static int do_print_lookup_table_entry(struct wim_lookup_table_entry *lte, + void *fp) { - print_lookup_table_entry(lte); + print_lookup_table_entry(lte, (FILE*)fp); return 0; } @@ -481,17 +537,16 @@ WIMLIBAPI void wimlib_print_lookup_table(WIMStruct *w) { for_lookup_table_entry(w->lookup_table, do_print_lookup_table_entry, - NULL); + stdout); } -/* - * Looks up an entry in the lookup table. - */ -struct lookup_table_entry * -__lookup_resource(const struct lookup_table *table, const u8 hash[]) +/* 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_resource(const struct wim_lookup_table *table, const u8 hash[]) { size_t i; - struct lookup_table_entry *lte; + struct wim_lookup_table_entry *lte; struct hlist_node *pos; wimlib_assert(table != NULL); @@ -513,15 +568,15 @@ __lookup_resource(const struct lookup_table *table, const u8 hash[]) */ int lookup_resource(WIMStruct *w, const char *path, int lookup_flags, - struct dentry **dentry_ret, - struct lookup_table_entry **lte_ret, + struct wim_dentry **dentry_ret, + struct wim_lookup_table_entry **lte_ret, u16 *stream_idx_ret) { - struct dentry *dentry; - struct lookup_table_entry *lte; + struct wim_dentry *dentry; + struct wim_lookup_table_entry *lte; u16 stream_idx; const char *stream_name = NULL; - struct inode *inode; + struct wim_inode *inode; char *p = NULL; if (lookup_flags & LOOKUP_FLAG_ADS_OK) { @@ -540,14 +595,14 @@ int lookup_resource(WIMStruct *w, const char *path, inode = dentry->d_inode; - wimlib_assert(inode->resolved); + wimlib_assert(inode->i_resolved); if (!(lookup_flags & LOOKUP_FLAG_DIRECTORY_OK) && inode_is_directory(inode)) return -EISDIR; if (stream_name) { - struct ads_entry *ads_entry; + struct wim_ads_entry *ads_entry; u16 ads_idx; ads_entry = inode_get_ads_entry(inode, stream_name, &ads_idx); @@ -559,7 +614,7 @@ int lookup_resource(WIMStruct *w, const char *path, return -ENOENT; } } else { - lte = inode->lte; + lte = inode->i_lte; stream_idx = 0; } out: @@ -573,65 +628,70 @@ out: } #endif -static void inode_resolve_ltes(struct inode *inode, struct lookup_table *table) +/* Resolve an inode'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. + */ +void inode_resolve_ltes(struct wim_inode *inode, struct wim_lookup_table *table) { - struct lookup_table_entry *lte; - - wimlib_assert(!inode->resolved); - - /* 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; + if (!inode->i_resolved) { + struct wim_lookup_table_entry *lte; + /* Resolve the default file stream */ + lte = __lookup_resource(table, inode->i_hash); + inode->i_lte = lte; + inode->i_resolved = 1; + + /* Resolve the alternate data streams */ + for (u16 i = 0; i < inode->i_num_ads; i++) { + struct wim_ads_entry *cur_entry = &inode->i_ads_entries[i]; + lte = __lookup_resource(table, cur_entry->hash); + cur_entry->lte = lte; + } } } -static void inode_unresolve_ltes(struct inode *inode) +void inode_unresolve_ltes(struct wim_inode *inode) { - wimlib_assert(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); + if (inode->i_resolved) { + if (inode->i_lte) + copy_hash(inode->i_hash, inode->i_lte->hash); else - zero_out_hash(inode->ads_entries[i].hash); + zero_out_hash(inode->i_hash); + + for (u16 i = 0; i < inode->i_num_ads; i++) { + if (inode->i_ads_entries[i].lte) + copy_hash(inode->i_ads_entries[i].hash, + inode->i_ads_entries[i].lte->hash); + else + zero_out_hash(inode->i_ads_entries[i].hash); + } + inode->i_resolved = 0; } - inode->resolved = false; } -/* 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. +/* + * 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 function always succeeds; unresolved lookup table entries are given a - * NULL pointer. + * This works for both resolved and un-resolved dentries. */ -int dentry_resolve_ltes(struct dentry *dentry, void *table) +struct wim_lookup_table_entry * +inode_stream_lte(const struct wim_inode *inode, unsigned stream_idx, + const struct wim_lookup_table *table) { - if (!dentry->d_inode->resolved) - inode_resolve_ltes(dentry->d_inode, table); - return 0; + if (inode->i_resolved) + return inode_stream_lte_resolved(inode, stream_idx); + else + return inode_stream_lte_unresolved(inode, stream_idx, table); } -int dentry_unresolve_ltes(struct dentry *dentry, void *ignore) -{ - if (dentry->d_inode->resolved) - inode_unresolve_ltes(dentry->d_inode); - return 0; -} /* Return the lookup table entry for the unnamed data stream of an inode, or * NULL if there is none. @@ -649,13 +709,26 @@ int dentry_unresolve_ltes(struct dentry *dentry, void *ignore) * 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 * -inode_unnamed_lte(const struct inode *inode, - const struct lookup_table *table) +struct wim_lookup_table_entry * +inode_unnamed_lte(const struct wim_inode *inode, + const struct wim_lookup_table *table) { - if (inode->resolved) + if (inode->i_resolved) return inode_unnamed_lte_resolved(inode); else return inode_unnamed_lte_unresolved(inode, table); } +static int lte_add_stream_size(struct wim_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 wim_lookup_table *table) +{ + u64 total_size = 0; + for_lookup_table_entry(table, lte_add_stream_size, &total_size); + return total_size; +}