]> wimlib.net Git - wimlib/blobdiff - src/lookup_table.h
Add more comments
[wimlib] / src / lookup_table.h
index 97d06ec76969d022359ddef792f201e432bc68ed..83796aae2d8bca57cf4566de9467755444da9cfa 100644 (file)
 #define LOOKUP_FLAG_ADS_OK             0x00000001
 #define LOOKUP_FLAG_DIRECTORY_OK       0x00000002
 
-/* Not yet used */
-//#define LOOKUP_FLAG_FOLLOW_SYMLINKS  0x00000004
+#ifdef __WIN32__
+#include <windef.h>
+#endif
 
 
-/* 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 list_head *unhashed_streams;
 };
 
-struct wimlib_fd;
-
 #ifdef WITH_NTFS_3G
 struct ntfs_location {
-       char *path_utf8;
-       char *stream_name_utf16;
-       u16 stream_name_utf16_num_chars;
-       struct _ntfs_volume **ntfs_vol_p;
+       tchar *path;
+       utf16lechar *stream_name;
+       u16 stream_name_nchars;
+       struct _ntfs_volume *ntfs_vol;
        bool is_reparse_point;
 };
 #endif
@@ -60,19 +69,35 @@ enum resource_location {
         * */
        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,
 
+#ifdef WITH_FUSE
+       /* The stream resource is located in an external file in the staging
+        * directory for a read-write mount.  */
+       RESOURCE_IN_STAGING_FILE,
+#endif
+
+#ifdef WITH_NTFS_3G
        /* 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,
+#endif
+
+#ifdef __WIN32__
+       /* Resource must be accessed using Win32 API (may be a named data
+        * stream) */
+       RESOURCE_WIN32,
+
+       /* Windows only: the file is on disk in the file named @file_on_disk,
+        * but the file is encrypted and must be read using special functions.
+        * */
+       RESOURCE_WIN32_ENCRYPTED,
+#endif
+
 };
 
 /*
@@ -86,7 +111,7 @@ enum resource_location {
  * The lookup_table_entry for a given dentry or alternate stream entry in the
  * 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;
@@ -110,8 +135,14 @@ struct lookup_table_entry {
         */
        u16 part_number;
 
-       /* See enum resource_location above */
-       u16 resource_location;
+       /* One of the `enum resource_location' values documented above. */
+       u16 resource_location : 5;
+
+       /* 1 if this stream is a unique size (only set while writing streams). */
+       u8 unique_size : 1;
+
+       /* 1 if this stream had a SHA1-message digest calculated for it yet? */
+       u8 unhashed : 1;
 
        /* (On-disk field)
         * Number of times this lookup table entry is referenced by dentries.
@@ -131,49 +162,57 @@ struct lookup_table_entry {
                 * the full 20 byte hash just to insert the entry in a hash
                 * table. */
                size_t hash_short;
+
+               /* Unhashed entries only (unhashed == 1): these variables make
+                * it possible to find the pointer to this 'struct
+                * wim_lookup_table_entry' contained in either 'struct
+                * wim_ads_entry' or 'struct wim_inode'.  There can be at most 1
+                * such pointer, as we can only join duplicate streams after
+                * they have been hashed.  */
+               struct {
+                       struct wim_inode *back_inode;
+                       u32 back_stream_id;
+               };
        };
 
-       #ifdef WITH_FUSE
-       u16 num_opened_fds;
-       #endif
+       /* When a WIM file is written, out_refcnt starts at 0 and is incremented
+        * whenever the stream pointed to by this lookup table entry needs to be
+        * written.  The stream only need to be written when out_refcnt is
+        * nonzero, since otherwise it is not referenced by any dentries. */
+       u32 out_refcnt;
 
        /* Pointers to somewhere where the stream is actually located.  See the
         * comments for the @resource_location field above. */
        union {
                WIMStruct *wim;
-               char *file_on_disk;
-               char *staging_file_name;
-               u8 *attached_buffer;
+               tchar *file_on_disk;
+               void *attached_buffer;
+       #ifdef WITH_FUSE
+               tchar *staging_file_name;
+       #endif
        #ifdef WITH_NTFS_3G
                struct ntfs_location *ntfs_loc;
        #endif
        };
-       union {
-               /* @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;
+       /* Actual reference count to this stream (only used while
+        * verifying an image). */
+       u32 real_refcnt;
+
+       union {
+       #ifdef WITH_FUSE
+               /* Number of times this stream has been opened (used only during
+                * mounting) */
+               u16 num_opened_fds;
        #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;
+               /* 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.  */
+               tchar *extracted_file;
        };
 
-       /* 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
-        * needs to be written.  The file resource only need to be written when
-        * out_refcnt is nonzero, since otherwise it is not referenced by any
-        * 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
@@ -185,35 +224,38 @@ struct lookup_table_entry {
                struct resource_entry output_resource_entry;
 
                struct list_head msg_list;
-               struct list_head dentry_list;
+               struct list_head inode_list;
+
+               struct {
+                       struct hlist_node hash_list_2;
+
+                       struct list_head write_streams_list;
+               };
        };
 
+       /* Temporary list fields */
        union {
-               /* 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;
-
-               /* 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;
+               struct list_head unhashed_list;
+               struct list_head swm_stream_list;
+               struct list_head extraction_list;
+               struct list_head export_stream_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_chunks(const struct lookup_table_entry *lte)
+static inline u64
+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 lookup_table_entry *lte)
+wim_resource_compressed_size(const struct wim_lookup_table_entry *lte)
 {
        return lte->resource_entry.size;
 }
@@ -223,138 +265,161 @@ wim_resource_compressed_size(const struct lookup_table_entry *lte)
  * 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);
 }
 
+static inline bool
+lte_filename_valid(const struct wim_lookup_table_entry *lte)
+{
+       return lte->resource_location == RESOURCE_IN_FILE_ON_DISK
+       #ifdef __WIN32__
+               || lte->resource_location == RESOURCE_WIN32
+               || lte->resource_location == RESOURCE_WIN32_ENCRYPTED
+       #endif
+       #ifdef WITH_FUSE
+               || lte->resource_location == RESOURCE_IN_STAGING_FILE
+       #endif
+               ;
+}
+
+extern struct wim_lookup_table *
+new_lookup_table(size_t capacity);
+
+extern int
+read_lookup_table(WIMStruct *w);
 
-extern struct lookup_table *new_lookup_table(size_t capacity);
+extern int
+write_lookup_table(WIMStruct *w, int image, struct resource_entry *out_res_entry);
 
-extern void lookup_table_insert(struct lookup_table *table,
-                               struct lookup_table_entry *lte);
+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)
 {
+       wimlib_assert(!lte->unhashed);
        hlist_del(&lte->hash_list);
+       wimlib_assert(table->num_entries != 0);
        table->num_entries--;
 }
 
-extern struct lookup_table_entry *new_lookup_table_entry();
+extern struct wim_lookup_table_entry *
+new_lookup_table_entry();
 
-extern struct lookup_table_entry *
-clone_lookup_table_entry(const struct lookup_table_entry *lte);
+extern struct wim_lookup_table_entry *
+clone_lookup_table_entry(const 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 void
+print_lookup_table_entry(const struct wim_lookup_table_entry *entry,
+                        FILE *out);
 
-extern struct lookup_table_entry *
-__lookup_resource(const struct lookup_table *table, const u8 hash[]);
+extern void
+free_lookup_table_entry(struct wim_lookup_table_entry *lte);
 
-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
+for_lookup_table_entry(struct wim_lookup_table *table,
+                      int (*visitor)(struct wim_lookup_table_entry *, void *),
+                      void *arg);
 
-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
+cmp_streams_by_wim_position(const void *p1, const void *p2);
 
-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 int
+for_lookup_table_entry_pos_sorted(struct wim_lookup_table *table,
+                                 int (*visitor)(struct wim_lookup_table_entry *,
+                                                void *),
+                                 void *arg);
 
-extern void print_lookup_table_entry(const struct lookup_table_entry *entry);
+extern struct wim_lookup_table_entry *
+__lookup_resource(const struct wim_lookup_table *table, const u8 hash[]);
 
-extern int read_lookup_table(WIMStruct *w);
+extern int
+lookup_resource(WIMStruct *w, const tchar *path,
+               int lookup_flags, struct wim_dentry **dentry_ret,
+               struct wim_lookup_table_entry **lte_ret, u16 *stream_idx_ret);
 
-extern void free_lookup_table(struct lookup_table *table);
+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 int write_lookup_table_entry(struct lookup_table_entry *lte, void *__out);
+extern int
+lte_zero_out_refcnt(struct wim_lookup_table_entry *entry, void *ignore);
 
-extern void free_lookup_table_entry(struct lookup_table_entry *lte);
+extern int
+lte_zero_real_refcnt(struct wim_lookup_table_entry *entry, void *ignore);
 
-extern int dentry_resolve_ltes(struct dentry *dentry, void *__table);
-extern int dentry_unresolve_ltes(struct dentry *dentry, void *ignore);
+extern int
+lte_free_extracted_file(struct wim_lookup_table_entry *lte, void *ignore);
 
-int write_lookup_table(struct lookup_table *table, FILE *out,
-                      struct resource_entry *out_res_entry);
+extern void
+inode_resolve_ltes(struct wim_inode *inode, struct wim_lookup_table *table);
 
-static inline struct resource_entry* wim_metadata_resource_entry(WIMStruct *w)
-{
-       return &w->image_metadata[
-                       w->current_image - 1].metadata_lte->resource_entry;
-}
+extern void
+inode_unresolve_ltes(struct wim_inode *inode);
+
+extern int
+write_lookup_table_entry(struct wim_lookup_table_entry *lte, void *__out);
 
-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;
@@ -369,51 +434,79 @@ static inline const u8 *inode_stream_hash_resolved(const struct inode *inode,
  *
  * 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_nbytes(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_nbytes;
 }
 
-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++)
-               if (inode_stream_name_len(inode, i) == 0 &&
-                    !is_zero_hash(inode_stream_hash_resolved(inode, i)))
+       wimlib_assert(inode->i_resolved);
+       for (unsigned i = 0; i <= inode->i_num_ads; i++) {
+               if (inode_stream_name_nbytes(inode, i) == 0 &&
+                   !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++)
-               if (inode_stream_name_len(inode, i) == 0 &&
-                    !is_zero_hash(inode_stream_hash_unresolved(inode, i)))
+       wimlib_assert(!inode->i_resolved);
+       for (unsigned i = 0; i <= inode->i_num_ads; i++) {
+               if (inode_stream_name_nbytes(inode, i) == 0 &&
+                   !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);
+
+
+static inline void
+lookup_table_insert_unhashed(struct wim_lookup_table *table,
+                            struct wim_lookup_table_entry *lte,
+                            struct wim_inode *back_inode,
+                            u32 back_stream_id)
+{
+       lte->unhashed = 1;
+       lte->back_inode = back_inode;
+       lte->back_stream_id = back_stream_id;
+       list_add_tail(&lte->unhashed_list, table->unhashed_streams);
+}
+
+extern int
+hash_unhashed_stream(struct wim_lookup_table_entry *lte,
+                    struct wim_lookup_table *lookup_table,
+                    struct wim_lookup_table_entry **lte_ret);
 
+extern struct wim_lookup_table_entry **
+retrieve_lte_pointer(struct wim_lookup_table_entry *lte);
 
 #endif