]> wimlib.net Git - wimlib/blobdiff - src/lookup_table.h
Support for encrypted restore
[wimlib] / src / lookup_table.h
index 62d02d6900cab7906d2e672f3226fbcd9a72b887..d9d8959c339c171fcdd517902dc07d37017f8ac3 100644 (file)
@@ -40,7 +40,7 @@ struct ntfs_location {
        tchar *path;
        utf16lechar *stream_name;
        u16 stream_name_nchars;
-       struct _ntfs_volume **ntfs_vol_p;
+       struct _ntfs_volume *ntfs_vol;
        bool is_reparse_point;
 };
 #endif
@@ -63,11 +63,11 @@ enum resource_location {
         * WIM file will be pointed to by the @wim member. */
        RESOURCE_IN_WIM,
 
+#ifndef __WIN32__
        /* 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.
-        * */
+        * file will be provided by @file_on_disk member. */
        RESOURCE_IN_FILE_ON_DISK,
+#endif
 
        /* The stream resource is directly attached in an in-memory buffer
         * pointed to by @attached_buffer. */
@@ -135,11 +135,19 @@ struct wim_lookup_table_entry {
         */
        u16 part_number;
 
-       /* See enum resource_location above */
+       /* 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 has not had a SHA1 message digest calculated for it
+        * yet */
        u8 unhashed : 1;
-       u8 is_ads : 1;
+
+       u8 deferred : 1;
+
+       u8 no_progress : 1;
 
        /* (On-disk field)
         * Number of times this lookup table entry is referenced by dentries.
@@ -160,14 +168,22 @@ struct wim_lookup_table_entry {
                 * table. */
                size_t hash_short;
 
-               struct wim_lookup_table_entry **my_ptr;
+               /* 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;
+               };
        };
 
        /* 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. */
+        * 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
@@ -175,24 +191,25 @@ struct wim_lookup_table_entry {
        union {
                WIMStruct *wim;
                tchar *file_on_disk;
-               tchar *staging_file_name;
                void *attached_buffer;
+       #ifdef WITH_FUSE
+               tchar *staging_file_name;
+       #endif
        #ifdef WITH_NTFS_3G
                struct ntfs_location *ntfs_loc;
        #endif
        };
 
-       /* Pointer to inode that contains the opened file descriptors to
-        * this stream (valid iff resource_location ==
-        * RESOURCE_IN_STAGING_FILE) */
-       struct wim_inode *lte_inode;
-
+       /* Actual reference count to this stream (only used while
+        * verifying an image). */
        u32 real_refcnt;
 
        union {
-               #ifdef WITH_FUSE
+       #ifdef WITH_FUSE
+               /* Number of times this stream has been opened (used only during
+                * mounting) */
                u16 num_opened_fds;
-               #endif
+       #endif
 
                /* This field is used for the special hardlink or symlink image
                 * extraction mode.   In these mode, all identical files are linked
@@ -204,29 +221,33 @@ struct wim_lookup_table_entry {
        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;
 
-               struct list_head msg_list;
+               struct {
+                       struct list_head msg_list;
+                       struct list_head being_compressed_list;
+               };
                struct list_head inode_list;
 
                struct {
                        struct hlist_node hash_list_2;
+
                        struct list_head write_streams_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;
+       /* Temporary list fields */
+       union {
+               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
@@ -263,10 +284,12 @@ wim_resource_compression_type(const struct wim_lookup_table_entry *lte)
 static inline bool
 lte_filename_valid(const struct wim_lookup_table_entry *lte)
 {
-       return lte->resource_location == RESOURCE_IN_FILE_ON_DISK
+       return 0
        #ifdef __WIN32__
                || lte->resource_location == RESOURCE_WIN32
                || lte->resource_location == RESOURCE_WIN32_ENCRYPTED
+       #else
+               || lte->resource_location == RESOURCE_IN_FILE_ON_DISK
        #endif
        #ifdef WITH_FUSE
                || lte->resource_location == RESOURCE_IN_STAGING_FILE
@@ -293,6 +316,7 @@ lookup_table_insert(struct wim_lookup_table *table, struct wim_lookup_table_entr
 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--;
@@ -317,7 +341,7 @@ for_lookup_table_entry(struct wim_lookup_table *table,
                       void *arg);
 
 extern int
-sort_stream_list_by_wim_position(struct list_head *stream_list);
+cmp_streams_by_wim_position(const void *p1, const void *p2);
 
 extern int
 for_lookup_table_entry_pos_sorted(struct wim_lookup_table *table,
@@ -439,34 +463,12 @@ inode_stream_name_nbytes(const struct wim_inode *inode, unsigned stream_idx)
                return inode->i_ads_entries[stream_idx - 1].stream_name_nbytes;
 }
 
-static inline struct wim_lookup_table_entry *
-inode_unnamed_lte_resolved(const struct wim_inode *inode)
-{
-       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;
-}
+extern struct wim_lookup_table_entry *
+inode_unnamed_lte_resolved(const struct wim_inode *inode);
 
-static inline struct wim_lookup_table_entry *
+extern struct wim_lookup_table_entry *
 inode_unnamed_lte_unresolved(const struct wim_inode *inode,
-                            const struct wim_lookup_table *table)
-{
-       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;
-}
+                            const struct wim_lookup_table *table);
 
 extern struct wim_lookup_table_entry *
 inode_unnamed_lte(const struct wim_inode *inode, const struct wim_lookup_table *table);
@@ -478,15 +480,21 @@ 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_lookup_table_entry **my_ptr)
+                            struct wim_inode *back_inode,
+                            u32 back_stream_id)
 {
        lte->unhashed = 1;
-       list_add_tail(&lte->staging_list, table->unhashed_streams);
-       lte->my_ptr = my_ptr;
-       *my_ptr = lte;
+       lte->back_inode = back_inode;
+       lte->back_stream_id = back_stream_id;
+       list_add_tail(&lte->unhashed_list, table->unhashed_streams);
 }
 
-extern void
-free_lte_list(struct list_head *list);
+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