X-Git-Url: https://wimlib.net/git/?a=blobdiff_plain;f=src%2Flookup_table.h;h=592116bcf55d60ef082f9bd5d48caac7bc218edb;hb=3ad1560f7040accb19afb4b31730d0820076b80b;hp=ede2bfe6fa5d7ba9be1444764f3877ad6fc95091;hpb=67f45cecd793345416d5d85fbe37ec54b1bb6ef8;p=wimlib diff --git a/src/lookup_table.h b/src/lookup_table.h index ede2bfe6..592116bc 100644 --- a/src/lookup_table.h +++ b/src/lookup_table.h @@ -36,16 +36,55 @@ struct ntfs_location { }; #endif -/* - * An entry in the lookup table in the WIM file. +/* An enumerated type that identifies where the stream corresponding to this + * lookup table entry is actually located. * - * It is used to find data streams for files in the WIM. + * If we open a WIM and read its lookup table, the location is set to + * RESOURCE_IN_WIM since all the streams will initially be located in the WIM. + * However, to deal with problems such as image capture and image mount, we + * allow the actual location of the stream to be somewhere else, such as an + * external file. + */ +enum resource_location { + /* The lookup table entry does not correspond to a stream (this state + * should exist only temporarily) */ + RESOURCE_NONEXISTENT = 0, + + /* The stream resource is located in a WIM file. The WIMStruct for the + * WIM file will be pointed to by the @wim member. */ + RESOURCE_IN_WIM, + + /* The stream resource is located in an external file. The name of the + * file will be provided by @file_on_disk member. In addition, if + * @file_on_disk_fp is not NULL, it will be an open FILE * to the file. + * */ + RESOURCE_IN_FILE_ON_DISK, + + /* The stream resource is located in an external file in the staging + * directory for a read-write mount. */ + RESOURCE_IN_STAGING_FILE, + + /* The stream resource is directly attached in an in-memory buffer + * pointed to by @attached_buffer. */ + RESOURCE_IN_ATTACHED_BUFFER, + + /* The stream resource is located in an NTFS volume. It is identified + * by volume, filename, data stream name, and by whether it is a reparse + * point or not. @ntfs_loc points to a structure containing this + * information. */ + RESOURCE_IN_NTFS_VOLUME, +}; + +/* + * An entry in the lookup table in the WIM file. + * + * It is used to find data streams for files in the WIM. * * Metadata resources and reparse point data buffers will also have lookup table * entries associated with the data. * * The lookup_table_entry for a given dentry or alternate stream entry in the - * WIM is found using the SHA1 message digest field. + * WIM is found using the SHA1 message digest field. */ struct lookup_table_entry { @@ -71,44 +110,8 @@ struct lookup_table_entry { */ u16 part_number; - /* An enumerated type that identifies where the stream corresponding to - * this lookup table entry is actually located. - * - * Obviously if we open a WIM and read its lookup table, the location is - * set to RESOURCE_IN_WIM since all the streams will initially be - * located in the WIM. However, to deal with problems such as image - * capture and image mount, we allow the actual location of the stream - * to be somewhere else, such as an external file. - */ - enum { - /* The lookup table entry does not correspond to a stream (this - * state should exist only temporarily) */ - RESOURCE_NONEXISTENT = 0, - - /* The stream resource is located in a WIM file. The WIMStruct - * for the WIM file will be pointed to by the @wim member. */ - RESOURCE_IN_WIM, - - /* The stream resource is located in an external file. The - * name of the file will be provided by @file_on_disk member. - * In addition, if @file_on_disk_fp is not NULL, it will be an - * open FILE * to the file. */ - RESOURCE_IN_FILE_ON_DISK, - - /* The stream resource is located in an external file in the - * staging directory for a read-write mount. */ - RESOURCE_IN_STAGING_FILE, - - /* The stream resource is directly attached in an in-memory - * buffer pointed to by @attached_buffer. */ - RESOURCE_IN_ATTACHED_BUFFER, - - /* The stream resource is located in an NTFS volume. It is - * identified by volume, filename, data stream name, and by - * whether it is a reparse point or not. @ntfs_loc points to a - * structure containing this information. */ - RESOURCE_IN_NTFS_VOLUME, - } resource_location; + /* See enum resource_location above */ + u16 resource_location; /* (On-disk field) * Number of times this lookup table entry is referenced by dentries. @@ -130,6 +133,10 @@ struct lookup_table_entry { size_t hash_short; }; + #ifdef WITH_FUSE + u16 num_opened_fds; + #endif + /* Pointers to somewhere where the stream is actually located. See the * comments for the @resource_location field above. */ union { @@ -142,29 +149,21 @@ struct lookup_table_entry { #endif }; union { - /* Temporary field for creating a singly linked list. Shouldn't - * really be here */ - struct lookup_table_entry *next_lte_in_swm; - /* @file_on_disk_fp and @attr are both used to cache file/stream * handles so we don't have re-open them on every read */ + + /* Valid iff resource_location == RESOURCE_IN_FILE_ON_DISK */ FILE *file_on_disk_fp; #ifdef WITH_NTFS_3G + /* Valid iff resource_location == RESOURCE_IN_NTFS_VOLUME */ struct _ntfs_attr *attr; #endif + + /* Pointer to inode that contains the opened file descriptors to + * this stream (valid iff resource_location == + * RESOURCE_IN_STAGING_FILE) */ + struct inode *lte_inode; }; -#ifdef WITH_FUSE - /* File descriptors table for this data stream. This is used if the WIM - * is mounted. Basically, each time a file is open()ed, a new file - * descriptor is added here, and each time a file is close()ed, the file - * descriptor is gotten rid of. If the stream is opened for writing, it - * will be extracted to the staging directory and there will be an - * actual native file descriptor associated with each "wimlib file - * descriptor". */ - u16 num_opened_fds; - u16 num_allocated_fds; - struct wimlib_fd **fds; -#endif /* When a WIM file is written, out_refcnt starts at 0 and is incremented * whenever the file resource pointed to by this lookup table entry @@ -173,35 +172,35 @@ struct lookup_table_entry { * dentries. */ u32 out_refcnt; + u32 real_refcnt; + union { /* When a WIM file is written, @output_resource_entry is filled * in with the resource entry for the output WIM. This will not - * necessarily be the same as the @resource_entry since: - * - The stream may have a different offset in the new WIM - * - The stream may have a different compressed size in the - * new WIM if the compression type changed + * necessarily be the same as the @resource_entry since: - The + * stream may have a different offset in the new WIM - The + * stream may have a different compressed size in the new WIM if + * the compression type changed */ struct resource_entry output_resource_entry; - /* This field is used for the special hardlink or symlink image - * application mode. In these mode, all identical files are - * linked together, and @extracted_file will be set to the - * filename of the first extracted file containing this stream. - * */ - char *extracted_file; + struct list_head msg_list; + struct list_head inode_list; }; - /* Circular linked list of streams that share the same lookup table - * entry. - * - * This list of streams may include streams from different hard link - * sets that happen to be the same. */ - struct list_head lte_group_list; - /* List of lookup table entries that correspond to streams that have * been extracted to the staging directory when modifying a read-write - * mounted WIM. */ + * mounted WIM. + * + * This field is also used to make other lists of lookup table entries. + * */ struct list_head staging_list; + + /* This field is used for the special hardlink or symlink image + * extraction mode. In these mode, all identical files are linked + * together, and @extracted_file will be set to the filename of the + * first extracted file containing this stream. */ + char *extracted_file; }; static inline u64 wim_resource_size(const struct lookup_table_entry *lte) @@ -209,6 +208,11 @@ static inline u64 wim_resource_size(const struct lookup_table_entry *lte) return lte->resource_entry.original_size; } +static inline u64 wim_resource_chunks(const struct lookup_table_entry *lte) +{ + return (wim_resource_size(lte) + WIM_CHUNK_SIZE - 1) / WIM_CHUNK_SIZE; +} + static inline u64 wim_resource_compressed_size(const struct lookup_table_entry *lte) { @@ -224,37 +228,31 @@ wim_resource_compression_type(const struct lookup_table_entry *lte) { if (!(lte->resource_entry.flags & WIM_RESHDR_FLAG_COMPRESSED) || lte->resource_location != RESOURCE_IN_WIM) - return WIM_COMPRESSION_TYPE_NONE; + return WIMLIB_COMPRESSION_TYPE_NONE; return wimlib_get_compression_type(lte->wim); } extern struct lookup_table *new_lookup_table(size_t capacity); -extern void lookup_table_insert(struct lookup_table *table, +extern void lookup_table_insert(struct lookup_table *table, struct lookup_table_entry *lte); /* Unlinks a lookup table entry from the table; does not free it. */ -static inline void lookup_table_unlink(struct lookup_table *table, +static inline void lookup_table_unlink(struct lookup_table *table, struct lookup_table_entry *lte) { hlist_del(<e->hash_list); table->num_entries--; } +extern struct lookup_table_entry *new_lookup_table_entry(); extern struct lookup_table_entry * -lookup_table_decrement_refcnt(struct lookup_table* table, const u8 hash[]); - -extern struct lookup_table_entry * -lte_decrement_refcnt(struct lookup_table_entry *lte, - struct lookup_table *table); - +clone_lookup_table_entry(const struct lookup_table_entry *lte); -extern struct lookup_table_entry *new_lookup_table_entry(); - -extern int for_lookup_table_entry(struct lookup_table *table, - int (*visitor)(struct lookup_table_entry *, void *), +extern int for_lookup_table_entry(struct lookup_table *table, + int (*visitor)(struct lookup_table_entry *, void *), void *arg); extern struct lookup_table_entry * @@ -263,9 +261,18 @@ __lookup_resource(const struct lookup_table *table, const u8 hash[]); extern 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); + +extern void lte_decrement_refcnt(struct lookup_table_entry *lte, + struct lookup_table *table); +#ifdef WITH_FUSE +extern void lte_decrement_num_opened_fds(struct lookup_table_entry *lte); +#endif -extern int zero_out_refcnts(struct lookup_table_entry *entry, void *ignore); +extern int lte_zero_out_refcnt(struct lookup_table_entry *entry, void *ignore); +extern int lte_zero_real_refcnt(struct lookup_table_entry *entry, void *ignore); +extern int lte_zero_extracted_file(struct lookup_table_entry *lte, void *ignore); +extern int lte_free_extracted_file(struct lookup_table_entry *lte, void *ignore); extern void print_lookup_table_entry(const struct lookup_table_entry *entry); @@ -277,21 +284,14 @@ extern int write_lookup_table_entry(struct lookup_table_entry *lte, void *__out) extern void free_lookup_table_entry(struct lookup_table_entry *lte); -extern int dentry_resolve_ltes(struct dentry *dentry, void *__table); +extern void inode_resolve_ltes(struct inode *inode, + struct lookup_table *table); -/* Writes the lookup table to the output file. */ -static inline int write_lookup_table(struct lookup_table *table, FILE *out) -{ - return for_lookup_table_entry(table, write_lookup_table_entry, out); -} +extern int dentry_resolve_ltes(struct dentry *dentry, void *__table); +extern int dentry_unresolve_ltes(struct dentry *dentry, void *ignore); -/* Unlinks and frees an entry from a lookup table. */ -static inline void lookup_table_remove(struct lookup_table *table, - struct lookup_table_entry *lte) -{ - lookup_table_unlink(table, lte); - free_lookup_table_entry(lte); -} +int write_lookup_table(struct lookup_table *table, FILE *out, + struct resource_entry *out_res_entry); static inline struct resource_entry* wim_metadata_resource_entry(WIMStruct *w) { @@ -307,12 +307,12 @@ inode_stream_lte_resolved(const struct inode *inode, unsigned stream_idx) if (stream_idx == 0) return inode->lte; else - return inode->ads_entries[stream_idx - 1]->lte; + return inode->ads_entries[stream_idx - 1].lte; } static inline struct lookup_table_entry * inode_stream_lte_unresolved(const struct inode *inode, unsigned stream_idx, - const struct lookup_table *table) + const struct lookup_table *table) { wimlib_assert(!inode->resolved); wimlib_assert(stream_idx <= inode->num_ads); @@ -323,9 +323,9 @@ inode_stream_lte_unresolved(const struct inode *inode, unsigned stream_idx, else return __lookup_resource(table, inode->ads_entries[ - stream_idx - 1]->hash); + stream_idx - 1].hash); } -/* +/* * 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. @@ -351,7 +351,7 @@ static inline const u8 *inode_stream_hash_unresolved(const struct inode *inode, if (stream_idx == 0) return inode->hash; else - return inode->ads_entries[stream_idx - 1]->hash; + return inode->ads_entries[stream_idx - 1].hash; } @@ -366,7 +366,7 @@ static inline const u8 *inode_stream_hash_resolved(const struct inode *inode, return zero_hash; } -/* +/* * Returns the hash 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. @@ -389,7 +389,7 @@ static inline u16 inode_stream_name_len(const struct inode *inode, if (stream_idx == 0) return 0; else - return inode->ads_entries[stream_idx - 1]->stream_name_len; + return inode->ads_entries[stream_idx - 1].stream_name_len; } static inline struct lookup_table_entry * @@ -419,5 +419,7 @@ extern struct lookup_table_entry * inode_unnamed_lte(const struct inode *inode, const struct lookup_table *table); +extern u64 lookup_table_total_stream_size(struct lookup_table *table); + #endif