#define LOOKUP_FLAG_ADS_OK 0x00000001
#define LOOKUP_FLAG_DIRECTORY_OK 0x00000002
-/* Not yet used */
-//#define LOOKUP_FLAG_FOLLOW_SYMLINKS 0x00000004
-
-/* A lookup table that is used to translate the hash codes of dentries into the
- * offsets and sizes of uncompressed or compressed file resources. It is
- * implemented as a hash table. */
-struct lookup_table {
+/* The lookup table of a WIM file maps SHA1 message digests to streams of data.
+ * Here, the in-memory structure is implemented as a hash table.
+ *
+ * Given a SHA1 message digest, the mapped-to stream is specified by an offset
+ * in the WIM, an uncompressed and compressed size, and resource flags (see
+ * 'struct resource_entry'). But, we associate additional information, such as
+ * a reference count, with each stream, so the actual mapping is from SHA1
+ * message digests to 'struct wim_lookup_table_entry's, each of which contains
+ * an embedded 'struct resource_entry'.
+ *
+ * Note: Everything will break horribly if there is a SHA1 collision.
+ */
+struct wim_lookup_table {
struct hlist_head *array;
u64 num_entries;
u64 capacity;
};
-struct wimlib_fd;
-
#ifdef WITH_NTFS_3G
struct ntfs_location {
char *path_utf8;
};
#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,
+
+ /* Resource must be accessed using Win32 API (may be a named data
+ * stream) */
+ RESOURCE_WIN32,
+};
+
+/*
+ * 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 {
+struct wim_lookup_table_entry {
/* List of lookup table entries in this hash bucket */
struct hlist_node hash_list;
*/
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.
size_t hash_short;
};
+ union {
+ #ifdef WITH_FUSE
+ u16 num_opened_fds;
+ #endif
+
+ /* 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;
+ };
+
/* Pointers to somewhere where the stream is actually located. See the
* comments for the @resource_location field above. */
union {
/* Pointer to inode that contains the opened file descriptors to
* this stream (valid iff resource_location ==
* RESOURCE_IN_STAGING_FILE) */
- struct inode *inode;
+ struct wim_inode *lte_inode;
};
-#ifdef WITH_FUSE
- u16 num_opened_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
u32 real_refcnt;
- /* 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
- */
- struct resource_entry output_resource_entry;
-
- /* 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;
-
union {
- /* List of lookup table entries that correspond to streams that have
- * been extracted to the staging directory when modifying a read-write
- * mounted WIM. */
- struct list_head staging_list;
-
- /* Temporary field for creating a singly linked list. */
- struct lookup_table_entry *next_lte_in_swm;
+ /* 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
+ */
+ struct resource_entry output_resource_entry;
+
+ struct list_head msg_list;
+ struct list_head inode_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.
+ *
+ * This field is also used to make other lists of lookup table entries.
+ * */
+ struct list_head staging_list;
};
-static inline u64 wim_resource_size(const struct lookup_table_entry *lte)
+static inline u64
+wim_resource_size(const struct wim_lookup_table_entry *lte)
{
return lte->resource_entry.original_size;
}
static inline u64
-wim_resource_compressed_size(const struct lookup_table_entry *lte)
+wim_resource_chunks(const struct wim_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 wim_lookup_table_entry *lte)
{
return lte->resource_entry.size;
}
* entry
*/
static inline int
-wim_resource_compression_type(const struct lookup_table_entry *lte)
+wim_resource_compression_type(const struct wim_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 struct wim_lookup_table *
+new_lookup_table(size_t capacity);
-extern void lookup_table_insert(struct lookup_table *table,
- struct lookup_table_entry *lte);
+extern int
+read_lookup_table(WIMStruct *w);
+
+extern int
+write_lookup_table(struct wim_lookup_table *table, FILE *out,
+ struct resource_entry *out_res_entry);
+extern void
+free_lookup_table(struct wim_lookup_table *table);
+
+extern void
+lookup_table_insert(struct wim_lookup_table *table, struct wim_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,
- struct lookup_table_entry *lte)
+static inline void
+lookup_table_unlink(struct wim_lookup_table *table, struct wim_lookup_table_entry *lte)
{
hlist_del(<e->hash_list);
table->num_entries--;
}
+extern struct wim_lookup_table_entry *
+new_lookup_table_entry();
-extern struct lookup_table_entry *
-lookup_table_decrement_refcnt(struct lookup_table* table, const u8 hash[]);
-
-#ifdef WITH_FUSE
-extern struct lookup_table_entry *
-lte_decrement_num_opened_fds(struct lookup_table_entry *lte,
- struct lookup_table *table);
-#endif
-
-extern struct lookup_table_entry *
-lte_decrement_refcnt(struct lookup_table_entry *lte,
- struct lookup_table *table);
+extern struct wim_lookup_table_entry *
+clone_lookup_table_entry(const struct wim_lookup_table_entry *lte);
+extern void
+print_lookup_table_entry(const struct wim_lookup_table_entry *entry,
+ FILE *out);
-extern struct lookup_table_entry *new_lookup_table_entry();
+extern void
+free_lookup_table_entry(struct wim_lookup_table_entry *lte);
-extern int for_lookup_table_entry(struct lookup_table *table,
- int (*visitor)(struct lookup_table_entry *, void *),
- void *arg);
+extern int
+for_lookup_table_entry(struct wim_lookup_table *table,
+ int (*visitor)(struct wim_lookup_table_entry *, void *),
+ void *arg);
-extern struct lookup_table_entry *
-__lookup_resource(const struct lookup_table *table, const u8 hash[]);
+extern struct wim_lookup_table_entry *
+__lookup_resource(const struct wim_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,
- u16 *stream_idx_ret);
+extern int
+lookup_resource(WIMStruct *w, const char *path,
+ int lookup_flags, struct wim_dentry **dentry_ret,
+ struct wim_lookup_table_entry **lte_ret, u16 *stream_idx_ret);
-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_free_extracted_file(struct lookup_table_entry *lte, void *ignone);
-
-extern void print_lookup_table_entry(const struct lookup_table_entry *entry);
-
-extern int read_lookup_table(WIMStruct *w);
+extern void
+lte_decrement_refcnt(struct wim_lookup_table_entry *lte,
+ struct wim_lookup_table *table);
+#ifdef WITH_FUSE
+extern void
+lte_decrement_num_opened_fds(struct wim_lookup_table_entry *lte);
+#endif
-extern void free_lookup_table(struct lookup_table *table);
+extern int
+lte_zero_out_refcnt(struct wim_lookup_table_entry *entry, void *ignore);
-extern int write_lookup_table_entry(struct lookup_table_entry *lte, void *__out);
+extern int
+lte_zero_real_refcnt(struct wim_lookup_table_entry *entry, void *ignore);
-extern void free_lookup_table_entry(struct lookup_table_entry *lte);
+extern int
+lte_free_extracted_file(struct wim_lookup_table_entry *lte, void *ignore);
-extern int dentry_resolve_ltes(struct dentry *dentry, void *__table);
+extern void
+inode_resolve_ltes(struct wim_inode *inode, struct wim_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 void
+inode_unresolve_ltes(struct wim_inode *inode);
-/* 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);
-}
+extern int
+write_lookup_table_entry(struct wim_lookup_table_entry *lte, void *__out);
-static inline struct resource_entry* wim_metadata_resource_entry(WIMStruct *w)
+static inline struct resource_entry*
+wim_metadata_resource_entry(WIMStruct *w)
{
return &w->image_metadata[
w->current_image - 1].metadata_lte->resource_entry;
}
-static inline struct lookup_table_entry *
-inode_stream_lte_resolved(const struct inode *inode, unsigned stream_idx)
+static inline struct wim_lookup_table_entry *
+inode_stream_lte_resolved(const struct wim_inode *inode, unsigned stream_idx)
{
- wimlib_assert(inode->resolved);
- wimlib_assert(stream_idx <= inode->num_ads);
+ wimlib_assert(inode->i_resolved);
+ wimlib_assert(stream_idx <= inode->i_num_ads);
if (stream_idx == 0)
- return inode->lte;
+ return inode->i_lte;
else
- return inode->ads_entries[stream_idx - 1].lte;
+ return inode->i_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)
+static inline struct wim_lookup_table_entry *
+inode_stream_lte_unresolved(const struct wim_inode *inode, unsigned stream_idx,
+ const struct wim_lookup_table *table)
{
- wimlib_assert(!inode->resolved);
- wimlib_assert(stream_idx <= inode->num_ads);
+ wimlib_assert(!inode->i_resolved);
+ wimlib_assert(stream_idx <= inode->i_num_ads);
if (!table)
return NULL;
if (stream_idx == 0)
- return __lookup_resource(table, inode->hash);
+ return __lookup_resource(table, inode->i_hash);
else
return __lookup_resource(table,
- inode->ads_entries[
+ inode->i_ads_entries[
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.
- *
- * This works for both resolved and un-resolved dentries.
- */
-static inline 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
- return inode_stream_lte_unresolved(inode, stream_idx, table);
-}
+extern struct wim_lookup_table_entry *
+inode_stream_lte(const struct wim_inode *inode, unsigned stream_idx,
+ const struct wim_lookup_table *table);
-static inline const u8 *inode_stream_hash_unresolved(const struct inode *inode,
- unsigned stream_idx)
+static inline const u8 *
+inode_stream_hash_unresolved(const struct wim_inode *inode, unsigned stream_idx)
{
- wimlib_assert(!inode->resolved);
- wimlib_assert(stream_idx <= inode->num_ads);
+ wimlib_assert(!inode->i_resolved);
+ wimlib_assert(stream_idx <= inode->i_num_ads);
if (stream_idx == 0)
- return inode->hash;
+ return inode->i_hash;
else
- return inode->ads_entries[stream_idx - 1].hash;
+ return inode->i_ads_entries[stream_idx - 1].hash;
}
-static inline const u8 *inode_stream_hash_resolved(const struct inode *inode,
- unsigned stream_idx)
+static inline const u8 *
+inode_stream_hash_resolved(const struct wim_inode *inode, unsigned stream_idx)
{
- struct lookup_table_entry *lte;
+ struct wim_lookup_table_entry *lte;
lte = inode_stream_lte_resolved(inode, stream_idx);
if (lte)
return lte->hash;
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.
*
* This works for both resolved and un-resolved dentries.
*/
-static inline const u8 *inode_stream_hash(const struct inode *inode,
- unsigned stream_idx)
+static inline const u8 *
+inode_stream_hash(const struct wim_inode *inode, unsigned stream_idx)
{
- if (inode->resolved)
+ if (inode->i_resolved)
return inode_stream_hash_resolved(inode, stream_idx);
else
return inode_stream_hash_unresolved(inode, stream_idx);
}
-static inline u16 inode_stream_name_len(const struct inode *inode,
- unsigned stream_idx)
+static inline u16
+inode_stream_name_len(const struct wim_inode *inode, unsigned stream_idx)
{
- wimlib_assert(stream_idx <= inode->num_ads);
+ wimlib_assert(stream_idx <= inode->i_num_ads);
if (stream_idx == 0)
return 0;
else
- return inode->ads_entries[stream_idx - 1].stream_name_len;
+ return inode->i_ads_entries[stream_idx - 1].stream_name_len;
}
-static inline struct lookup_table_entry *
-inode_unnamed_lte_resolved(const struct inode *inode)
+static inline struct wim_lookup_table_entry *
+inode_unnamed_lte_resolved(const struct wim_inode *inode)
{
- wimlib_assert(inode->resolved);
- for (unsigned i = 0; i <= inode->num_ads; i++)
+ wimlib_assert(inode->i_resolved);
+ for (unsigned i = 0; i <= inode->i_num_ads; i++) {
if (inode_stream_name_len(inode, i) == 0 &&
- !is_zero_hash(inode_stream_hash_resolved(inode, i)))
+ !is_zero_hash(inode_stream_hash_resolved(inode, i)))
+ {
return inode_stream_lte_resolved(inode, i);
+ }
+ }
return NULL;
}
-static inline struct lookup_table_entry *
-inode_unnamed_lte_unresolved(const struct inode *inode,
- const struct lookup_table *table)
+static inline struct wim_lookup_table_entry *
+inode_unnamed_lte_unresolved(const struct wim_inode *inode,
+ const struct wim_lookup_table *table)
{
- wimlib_assert(!inode->resolved);
- for (unsigned i = 0; i <= inode->num_ads; i++)
+ wimlib_assert(!inode->i_resolved);
+ for (unsigned i = 0; i <= inode->i_num_ads; i++) {
if (inode_stream_name_len(inode, i) == 0 &&
- !is_zero_hash(inode_stream_hash_unresolved(inode, i)))
+ !is_zero_hash(inode_stream_hash_unresolved(inode, i)))
+ {
return inode_stream_lte_unresolved(inode, i, table);
+ }
+ }
return NULL;
}
-extern struct lookup_table_entry *
-inode_unnamed_lte(const struct inode *inode,
- const struct lookup_table *table);
+extern struct wim_lookup_table_entry *
+inode_unnamed_lte(const struct wim_inode *inode, const struct wim_lookup_table *table);
+extern u64
+lookup_table_total_stream_size(struct wim_lookup_table *table);
#endif