]> wimlib.net Git - wimlib/blobdiff - src/wimlib_internal.h
inode updates (IN PROGRESS)
[wimlib] / src / wimlib_internal.h
index 1a2654c93f8abf27c9afb8d4ccf7e36cdf6b6f3d..4e2f1d26d311fe9fa819190234f8a9ac633faee9 100644 (file)
  * This file is part of wimlib, a library for working with WIM files.
  *
  * wimlib is free software; you can redistribute it and/or modify it under the
- * terms of the GNU Lesser General Public License as published by the Free
- * Software Foundation; either version 2.1 of the License, or (at your option)
+ * terms of the GNU General Public License as published by the Free
+ * Software Foundation; either version 3 of the License, or (at your option)
  * any later version.
  *
  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+ * A PARTICULAR PURPOSE. See the GNU General Public License for more
  * details.
  *
- * You should have received a copy of the GNU Lesser General Public License
+ * You should have received a copy of the GNU General Public License
  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  */
 
 #define _WIMLIB_INTERNAL_H
 
 #include "util.h"
+#include "list.h"
 
 struct stat;
+struct dentry;
+struct inode;
 
 #define WIM_MAGIC_LEN  8
 #define WIM_GID_LEN    16
@@ -71,16 +74,23 @@ struct resource_entry {
 
 /* Flags for the `flags' field of the struct resource_entry structure. */
 
-/* ??? */
+/* I haven't seen this flag used in any of the WIMs I have examined.  I assume
+ * it means that there are no references to the stream, so the space is free.
+ * However, even after deleting files from a WIM mounted with `imagex.exe
+ * /mountrw', I could not see this flag being used.  Either way, we don't
+ * actually use this flag for anything. */
 #define WIM_RESHDR_FLAG_FREE            0x01
 
-/* Indicates that a file resource is a metadata resource. */
+/* Indicates that the stream is a metadata resource for a WIM image. */
 #define WIM_RESHDR_FLAG_METADATA        0x02
 
-/* Indicates that a file resource is compressed. */
+/* Indicates that the stream is compressed. */
 #define WIM_RESHDR_FLAG_COMPRESSED     0x04
 
-/* ??? */
+/* I haven't seen this flag used in any of the WIMs I have examined.  Perhaps it
+ * means that a stream could possibly be split among multiple split WIM parts.
+ * However, `imagex.exe /split' does not seem to create any WIMs like this.
+ * Either way, we don't actually use this flag for anything.  */
 #define WIM_RESHDR_FLAG_SPANNED         0x08
 
 
@@ -142,8 +152,7 @@ struct wim_header {
        //u8 unused[WIM_UNUSED_LEN];
 };
 
-/* Flags for the `flags' field of the struct wim_header. */
-
+/* Flags for the `flags' field of the struct wim_header: */
 
 /* Reserved for future use by M$ */
 #define WIM_HDR_FLAG_RESERVED           0x00000001
@@ -151,26 +160,31 @@ struct wim_header {
 /* Files and metadata in the WIM are compressed. */
 #define WIM_HDR_FLAG_COMPRESSION        0x00000002
 
-/* WIM is read-only. */
+/* WIM is read-only (we ignore this). */
 #define WIM_HDR_FLAG_READONLY           0x00000004
 
 /* Resource data specified by images in this WIM may be contained in a different
- * WIM */
+ * WIM.  Or in other words, this WIM is part of a split WIM.  */
 #define WIM_HDR_FLAG_SPANNED            0x00000008
 
-/* The WIM contains resources only; no filesystem metadata. */
+/* The WIM contains resources only; no filesystem metadata.  We ignore this
+ * flag, as we look for file resources in all the WIMs anyway. */
 #define WIM_HDR_FLAG_RESOURCE_ONLY      0x00000010
 
-/* The WIM contains metadata only. */
+/* The WIM contains metadata only.  We ignore this flag.  Note that all the
+ * metadata resources for a split WIM should be in the first part. */
 #define WIM_HDR_FLAG_METADATA_ONLY      0x00000020
 
-/* Lock field to prevent multiple writers from writing the WIM concurrently. */
+/* Lock field to prevent multiple writers from writing the WIM concurrently.  We
+ * ignore this flag. */
 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS  0x00000040 
 
-/* Reparse point fixup ??? */
+/* Reparse point fixup ???
+ * This has something to do with absolute targets of reparse points / symbolic
+ * links but I don't know what.  We ignore this flag.  */
 #define WIM_HDR_FLAG_RP_FIX             0x00000080
 
-/* Unknown compression type */
+/* Unused, reserved flag for another compression type */
 #define WIM_HDR_FLAG_COMPRESS_RESERVED  0x00010000
 
 /* Resources within the WIM are compressed using "XPRESS" compression, which is
@@ -181,7 +195,9 @@ struct wim_header {
  * a LZ77-based algorithm. */
 #define WIM_HDR_FLAG_COMPRESS_LZX       0x00040000
 
-typedef struct _ntfs_volume ntfs_volume;
+#ifdef WITH_NTFS_3G
+struct _ntfs_volume;
+#endif
 
 /* Structure for security data.  Each image in the WIM file has its own security
  * data. */
@@ -191,8 +207,11 @@ struct wim_security_data {
         * that wimlib writes, currently), it will be 8 bytes. */
        u32 total_length;
 
-       /* The number of security descriptors in the array @descriptors, below. */
-       u32 num_entries;
+       /* The number of security descriptors in the array @descriptors, below.  
+        * It is really an unsigned int, but it must fit into an int because the
+        * security ID's are signed.  (Not like you would ever have more than a
+        * few hundred security descriptors anyway). */
+       int32_t num_entries;
 
        /* Array of sizes of the descriptors in the array @descriptors. */
        u64 *sizes;
@@ -205,7 +224,7 @@ struct wim_security_data {
        u32 refcnt;
 };
 
-struct link_group_table;
+struct inode_table;
 
 
 /* Metadata resource for an image. */
@@ -216,13 +235,12 @@ struct image_metadata {
        /* Pointer to the security data for the image. */
        struct wim_security_data *security_data;
 
-       /* Hard link group table */
-       struct link_group_table *lgt;
-
        /* A pointer to the lookup table entry for this image's metadata
         * resource. */
        struct lookup_table_entry *metadata_lte;
 
+       struct hlist_head inode_list;
+
        /* True if the filesystem of the image has been modified.  If this is
         * the case, the memory for the filesystem is not freed when switching
         * to a different WIM image. */
@@ -266,8 +284,10 @@ typedef struct WIMStruct {
                int add_flags;
                int write_flags;
                bool write_metadata;
-               ntfs_volume *ntfs_vol;
        };
+#ifdef WITH_NTFS_3G
+       struct _ntfs_volume *ntfs_vol;
+#endif
 
        /* The currently selected image, indexed starting at 1.  If not 0,
         * subtract 1 from this to get the index of the current image in the
@@ -312,14 +332,54 @@ wim_get_current_image_metadata(WIMStruct *w)
        return &w->image_metadata[w->current_image - 1];
 }
 
+struct pattern_list {
+       const char **pats;
+       size_t num_pats;
+       size_t num_allocated_pats;
+};
+
+struct capture_config {
+       struct pattern_list exclusion_list;
+       struct pattern_list exclusion_exception;
+       struct pattern_list compression_exclusion_list;
+       struct pattern_list alignment_list;
+       char *config_str;
+       char *prefix;
+       size_t prefix_len;
+};
+
 /* hardlink.c */
 
-struct link_group_table *new_link_group_table(u64 capacity);
-int link_group_table_insert(struct dentry *dentry,
-                           void *__table);
-void free_link_group_table(struct link_group_table *table);
-u64 assign_link_groups(struct link_group_table *table);
-int link_groups_free_duplicate_data(struct link_group_table *table);
+/* Hash table to find inodes, identified by their inode ID.
+ * */
+struct inode_table {
+       /* Fields for the hash table */
+       struct hlist_head *array;
+       u64 num_entries;
+       u64 capacity;
+
+       /* 
+        * Linked list of "extra" inodes.  These may be:
+        *
+        * - inodes with link count 1, which are all allowed to have 0 for their
+        *   inode number, meaning we cannot insert them into the hash table
+        *   before calling assign_inode_numbers().
+         *
+        * - Groups we create ourselves by splitting a nominal inode due to
+        *   inconsistencies in the dentries.  These inodes will share a inode
+        *   ID with some other inode until assign_inode_numbers() is called.
+        */
+       struct hlist_head extra_inodes;
+};
+
+int init_inode_table(struct inode_table *table, size_t capacity);
+static inline void destroy_inode_table(struct inode_table *table)
+{
+       FREE(table->array);
+}
+int inode_table_insert(struct dentry *dentry, void *__table);
+u64 assign_inode_numbers(struct hlist_head *inode_list);
+int fix_inodes(struct inode_table *table, struct hlist_head *inode_list);
 
 
 /* header.c */
@@ -333,15 +393,30 @@ extern int write_integrity_table(FILE *out, u64 end_header_offset,
                                 int show_progress);
 extern int check_wim_integrity(WIMStruct *w, int show_progress, int *status);
 
+/* join.c */
+
+extern int new_joined_lookup_table(WIMStruct *w,
+                                  WIMStruct **additional_swms,
+                                  unsigned num_additional_swms,
+                                  struct lookup_table **table_ret);
+
+extern int verify_swm_set(WIMStruct *w,
+                         WIMStruct **additional_swms,
+                         unsigned num_additional_swms);
 /* modify.c */
 extern void destroy_image_metadata(struct image_metadata *imd,
                                   struct lookup_table *lt);
+extern bool exclude_path(const char *path,
+                        const struct capture_config *config,
+                        bool exclude_prefix);
 extern int do_add_image(WIMStruct *w, const char *dir, const char *name,
-                       const char *description, const char *flags_element,
+                       const char *config_str, size_t config_len,
                        int flags,
-                       int (*capture_tree)(struct dentry *, const char *,
+                       int (*capture_tree)(struct dentry **, const char *,
                                     struct lookup_table *, 
-                                    struct wim_security_data *, int, void *),
+                                    struct wim_security_data *, 
+                                    const struct capture_config *,
+                                    int, void *),
                        void *extra_arg);
 
 /* resource.c */
@@ -362,7 +437,7 @@ extern int extract_wim_resource_to_fd(const struct lookup_table_entry *lte,
 extern int extract_full_wim_resource_to_fd(const struct lookup_table_entry *lte,
                                           int fd);
 
-extern int read_metadata_resource(FILE *fp, int wim_ctype, 
+extern int read_metadata_resource(WIMStruct *w,
                                  struct image_metadata *image_metadata);
 
 
@@ -380,14 +455,14 @@ u8 *write_security_data(const struct wim_security_data *sd, u8 *p);
 void free_security_data(struct wim_security_data *sd);
 
 /* symlink.c */
-ssize_t dentry_readlink(const struct dentry *dentry, char *buf, size_t buf_len,
+ssize_t inode_readlink(const struct inode *inode, char *buf, size_t buf_len,
                        const WIMStruct *w);
 extern void *make_symlink_reparse_data_buf(const char *symlink_target,
                                           size_t *len_ret);
-extern int dentry_set_symlink(struct dentry *dentry,
-                             const char *target,
-                             struct lookup_table *lookup_table,
-                             struct lookup_table_entry **lte_ret);
+extern int inode_set_symlink(struct inode *inode,
+                            const char *target,
+                            struct lookup_table *lookup_table,
+                            struct lookup_table_entry **lte_ret);
 
 /* wim.c */
 extern WIMStruct *new_wim_struct();