Add support for unsafe in-place compaction of WIM files

[wimlib] / include / wimlib / wim.h

diff --git a/include/wimlib/wim.h b/include/wimlib/wim.h
index 5bc20a6b0e6823b39cefff0588400d7dff926c47..4cf6779f93830cf4227773b046f87de5130b1983 100644 (file)
--- a/include/wimlib/wim.h
+++ b/include/wimlib/wim.h
@@ -11,8 +11,8 @@
 #include "wimlib/list.h"
 
 struct wim_image_metadata;
-struct wim_info;
-struct wim_lookup_table;
+struct wim_xml_info;
+struct blob_table;
 
 /*
  * WIMStruct - represents a WIM, or a part of a non-standalone WIM
@@ -29,7 +29,7 @@ struct wim_lookup_table;
  *
  * Note 2: although this is the top-level data structure in wimlib, there do
  * exist cases in which a WIMStruct is not standalone:
- *     - streams have been referenced from another WIMStruct
+ *     - blobs have been referenced from another WIMStruct
  *     - an image has been imported into this WIMStruct from another
  *       (as this references the metadata rather than copies it)
  *
@@ -42,10 +42,14 @@ struct WIMStruct {
 
        /* Information from the header of the WIM file.
         *
-        * This is also maintained for a WIMStruct not backed by a file, but the
-        * 'reshdr' fields have no meaning.  */
+        * This is also maintained for a WIMStruct not backed by a file, but in
+        * that case the 'reshdr' fields are left zeroed.  */
        struct wim_header hdr;
 
+       /* If the library is currently writing this WIMStruct out to a file,
+        * then this is the header being created for that file.  */
+       struct wim_header out_hdr;
+
        /* Array of image metadata, one for each image in the WIM (array length
         * hdr.image_count).  Or, this will be NULL if this WIM does not contain
         * metadata, which implies that this WIMStruct either represents part of
@@ -55,13 +59,13 @@ struct WIMStruct {
 
        /* Information from the XML data of the WIM file.  This information is
         * also maintained for a WIMStruct not backed by a file.  */
-       struct wim_info *wim_info;
+       struct wim_xml_info *xml_info;
 
-       /* The lookup table for this WIMStruct.  If this WIMStruct has a backing
-        * file, then this table will index the streams contained in that file.
-        * In addition, this table may index streams that were added by updates
-        * or referenced from other WIMStructs.  */
-       struct wim_lookup_table *lookup_table;
+       /* The blob table for this WIMStruct.  If this WIMStruct has a backing
+        * file, then this table will index the blobs contained in that file.
+        * In addition, this table may index blobs that were added by updates or
+        * referenced from other WIMStructs.  */
+       struct blob_table *blob_table;
 
        /*
         * The 1-based index of the currently selected image in this WIMStruct,
@@ -120,6 +124,10 @@ struct WIMStruct {
        /* 1 if the WIM file has been locked for appending, otherwise 0  */
        u8 locked_for_append : 1;
 
+       /* 1 if the WIM file is currently being compacted by wimlib_overwrite()
+        * with WIMLIB_WRITE_FLAG_UNSAFE_COMPACT  */
+       u8 being_compacted : 1;
+
        /* If this WIM is backed by a file, then this is the compression type
         * for non-solid resources in that file.  */
        u8 compression_type;
@@ -154,7 +162,7 @@ struct WIMStruct {
 
 /*
  * Return true if and only if the WIM contains image metadata (actual directory
- * trees, not just a collection of streams and their checksums).
+ * trees, not just a collection of blobs and their checksums).
  *
  * See the description of the 'image_metadata' field.  Note that we return true
  * when the image count is 0 because it could be a WIM with 0 images.  It's only
@@ -182,21 +190,15 @@ static inline bool wim_is_pipable(const WIMStruct *wim)
        return (wim->hdr.magic == PWM_MAGIC);
 }
 
-extern int
-set_wim_hdr_cflags(int ctype, struct wim_header *hdr);
-
-extern int
-init_wim_header(struct wim_header *hdr, int ctype, u32 chunk_size);
+extern bool
+wim_has_solid_resources(const WIMStruct *wim);
 
 extern int
 read_wim_header(WIMStruct *wim, struct wim_header *hdr);
 
 extern int
-write_wim_header(const struct wim_header *hdr, struct filedes *out_fd);
-
-extern int
-write_wim_header_at_offset(const struct wim_header *hdr, struct filedes *out_fd,
-                          off_t offset);
+write_wim_header(const struct wim_header *hdr, struct filedes *out_fd,
+                off_t offset);
 
 extern int
 write_wim_header_flags(u32 hdr_flags, struct filedes *out_fd);
@@ -211,7 +213,7 @@ extern int
 for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *));
 
 extern int
-wim_checksum_unhashed_streams(WIMStruct *wim);
+wim_checksum_unhashed_blobs(WIMStruct *wim);
 
 extern int
 delete_wim_image(WIMStruct *wim, int image);