Make WIMStructs reference-counted

[wimlib] / include / wimlib / wim.h

diff --git a/include/wimlib/wim.h b/include/wimlib/wim.h
index b0d351ec06b5878cd717e529de34894c77705342..00de8a53118a74d634b1d3385bfe16f3593015a2 100644 (file)
--- a/include/wimlib/wim.h
+++ b/include/wimlib/wim.h
@@ -11,7 +11,7 @@
 #include "wimlib/list.h"
 
 struct wim_image_metadata;
-struct wim_info;
+struct wim_xml_info;
 struct blob_table;
 
 /*
@@ -29,7 +29,7 @@ struct blob_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,7 +59,7 @@ 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 blob table for this WIMStruct.  If this WIMStruct has a backing
         * file, then this table will index the blobs contained in that file.
@@ -63,6 +67,11 @@ struct WIMStruct {
         * referenced from other WIMStructs.  */
        struct blob_table *blob_table;
 
+       /* The number of references to this WIMStruct.  This is equal to the
+        * number of resource descriptors that reference this WIMStruct, plus 1
+        * if wimlib_free() still needs to be called.  */
+       ssize_t refcnt;
+
        /*
         * The 1-based index of the currently selected image in this WIMStruct,
         * or WIMLIB_NO_IMAGE if no image is currently selected.
@@ -101,16 +110,6 @@ struct WIMStruct {
        u8 decompressor_ctype;
        u32 decompressor_max_block_size;
 
-       /*
-        * 'subwims' is the list of dependent WIMStructs (linked by
-        * 'subwim_node') that have been opened by calls to
-        * wimlib_reference_resource_files().  These WIMStructs must be retained
-        * so that resources from them can be used.  They are internal to the
-        * library and are not visible to API users.
-        */
-       struct list_head subwims;
-       struct list_head subwim_node;
-
        /* Temporary field; use sparingly  */
        void *private;
 
@@ -120,6 +119,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 +157,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,24 +185,18 @@ static inline bool wim_is_pipable(const WIMStruct *wim)
        return (wim->hdr.magic == PWM_MAGIC);
 }
 
+extern void
+finalize_wim_struct(WIMStruct *wim);
+
 extern bool
 wim_has_solid_resources(const WIMStruct *wim);
 
-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 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);