]> wimlib.net Git - wimlib/blobdiff - src/wimlib_internal.h
Move VERBOSE flags to progress callbacks
[wimlib] / src / wimlib_internal.h
index f9a4ad8af5a6a1138868e9cd0baae00fe2057047..b0a0aa29e5e9ab8d7790f24a8209c8478160b312 100644 (file)
 #ifndef _WIMLIB_INTERNAL_H
 #define _WIMLIB_INTERNAL_H
 
+#include "config.h"
 #include "util.h"
+#include "list.h"
+
+#ifdef WITH_FUSE
+#include <pthread.h>
+#endif
 
 struct stat;
-struct hlist_head;
+struct dentry;
 struct inode;
 
+#include "wimlib.h"
+
 #define WIM_MAGIC_LEN  8
 #define WIM_GID_LEN    16
 #define WIM_UNUSED_LEN 60
@@ -49,11 +57,9 @@ struct inode;
  * yet.  The differences between the versions are undocumented. */
 #define WIM_VERSION 0x10d00
 
-enum wim_integrity_status {
-       WIM_INTEGRITY_OK,
-       WIM_INTEGRITY_NOT_OK,
-       WIM_INTEGRITY_NONEXISTENT,
-};
+#define WIM_INTEGRITY_OK 0
+#define WIM_INTEGRITY_NOT_OK -1
+#define WIM_INTEGRITY_NONEXISTENT -2
 
 /* Metadata for a resource in a WIM file. */
 struct resource_entry {
@@ -94,10 +100,10 @@ struct resource_entry {
 
 
 /* Header at the very beginning of the WIM file. */
-struct wim_header { 
+struct wim_header {
        /* Identifies the file as WIM file. Must be exactly
         * {'M', 'S', 'W', 'I', 'M', 0, 0, 0}  */
-       //u8  magic[WIM_MAGIC_LEN];     
+       //u8  magic[WIM_MAGIC_LEN];
 
        /* size of WIM header in bytes. */
        //u32 hdr_size;
@@ -115,7 +121,7 @@ struct wim_header {
         * WIM_CHUNK_SIZE.  M$ incorrectly documents this as "the size of the
         * compressed .wim file in bytes".*/
        //u32 chunk_size;
-       
+
        /* A unique identifier for the WIM file. */
        u8  guid[WIM_GID_LEN];
 
@@ -141,7 +147,7 @@ struct wim_header {
 
        /* The index of the bootable image in the WIM file. If 0, there are no
         * bootable images available. */
-       u32 boot_idx; 
+       u32 boot_idx;
 
        /* The location of the optional integrity table used to verify the
         * integrity WIM.  Zeroed out if there is no integrity table.*/
@@ -176,7 +182,7 @@ struct wim_header {
 
 /* Lock field to prevent multiple writers from writing the WIM concurrently.  We
  * ignore this flag. */
-#define WIM_HDR_FLAG_WRITE_IN_PROGRESS  0x00000040 
+#define WIM_HDR_FLAG_WRITE_IN_PROGRESS  0x00000040
 
 /* Reparse point fixup ???
  * This has something to do with absolute targets of reparse points / symbolic
@@ -206,7 +212,7 @@ 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.  
+       /* 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). */
@@ -238,49 +244,60 @@ struct image_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. */
-       bool modified;
+       u8 modified : 1;
 
+       u8 has_been_mounted_rw : 1;
 };
 
+#define WIMLIB_RESOURCE_FLAG_RAW               0x1
+#define WIMLIB_RESOURCE_FLAG_MULTITHREADED     0x2
+#define WIMLIB_RESOURCE_FLAG_RECOMPRESS                0x4
+
 /* The opaque structure exposed to the wimlib API. */
 typedef struct WIMStruct {
 
        /* A pointer to the file indicated by @filename, opened for reading. */
-       FILE  *fp;
+       FILE *fp;
+
+#ifdef WITH_FUSE
+       /* Extra file pointers to be used by concurrent readers */
+       FILE **fp_tab;
+       size_t num_allocated_fps;
+       pthread_mutex_t fp_tab_mutex;
+#endif
 
        /* FILE pointer for the WIM file that is being written. */
-       FILE  *out_fp;
+       FILE *out_fp;
 
        /* The name of the WIM file that has been opened. */
-       char  *filename;
+       char *filename;
 
-       /* The lookup table for the WIM file. */ 
+       /* The lookup table for the WIM file. */
        struct lookup_table *lookup_table;
 
        /* Pointer to the XML data read from the WIM file. */
-       u8    *xml_data;
+       u8 *xml_data;
 
        /* Information retrieved from the XML data, arranged
         * in an orderly manner. */
-       struct wim_info      *wim_info;
+       struct wim_info *wim_info;
 
        /* Array of the image metadata of length image_count.  Each image in the
         * WIM has a image metadata associated with it. */
-       struct image_metadata     *image_metadata;
+       struct image_metadata *image_metadata;
 
        /* The header of the WIM file. */
-       struct wim_header    hdr;
+       struct wim_header hdr;
 
-       /* Temporary flags to use when extracting a WIM image or adding a WIM
-        * image. */
+       /* Temporary fields */
        union {
-               int extract_flags;
-               int add_flags;
-               int write_flags;
                bool write_metadata;
+               void *private;
        };
 #ifdef WITH_NTFS_3G
        struct _ntfs_volume *ntfs_vol;
@@ -290,6 +307,9 @@ typedef struct WIMStruct {
         * subtract 1 from this to get the index of the current image in the
         * image_metadata array. */
        int current_image;
+
+       /* %true iff any images have been deleted from this WIM. */
+       bool deletion_occurred;
 } WIMStruct;
 
 
@@ -347,11 +367,36 @@ struct capture_config {
 
 /* hardlink.c */
 
-struct inode_table *new_inode_table(size_t capacity);
-int inode_table_insert(struct dentry *dentry, void *__table);
-void free_inode_table(struct inode_table *table);
-u64 assign_inode_numbers(struct hlist_head *inode_list);
-int fix_inodes(struct inode_table *table, struct hlist_head *inode_list);
+/* 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;
+};
+
+extern int init_inode_table(struct inode_table *table, size_t capacity);
+static inline void destroy_inode_table(struct inode_table *table)
+{
+       FREE(table->array);
+}
+extern int inode_table_insert(struct dentry *dentry, void *__table);
+extern u64 assign_inode_numbers(struct hlist_head *inode_list);
+extern int fix_inodes(struct inode_table *table, struct hlist_head *inode_list);
 
 
 /* header.c */
@@ -360,10 +405,14 @@ extern int write_header(const struct wim_header *hdr, FILE *out);
 extern int init_header(struct wim_header *hdr, int ctype);
 
 /* integrity.c */
-extern int write_integrity_table(FILE *out, u64 end_header_offset, 
-                                u64 end_lookup_table_offset,
-                                int show_progress);
-extern int check_wim_integrity(WIMStruct *w, int show_progress, int *status);
+extern int write_integrity_table(FILE *out,
+                                struct resource_entry *integrity_res_entry,
+                                off_t new_lookup_table_end,
+                                off_t old_lookup_table_end,
+                                wimlib_progress_func_t progress_func);
+
+extern int check_wim_integrity(WIMStruct *w,
+                              wimlib_progress_func_t progress_func);
 
 /* join.c */
 
@@ -385,11 +434,41 @@ extern int do_add_image(WIMStruct *w, const char *dir, const char *name,
                        const char *config_str, size_t config_len,
                        int flags,
                        int (*capture_tree)(struct dentry **, const char *,
-                                    struct lookup_table *, 
-                                    struct wim_security_data *, 
+                                    struct lookup_table *,
+                                    struct wim_security_data *,
                                     const struct capture_config *,
                                     int, void *),
-                       void *extra_arg);
+                       void *extra_arg,
+                       wimlib_progress_func_t progress_func);
+
+/* ntfs-apply.c */
+
+struct apply_args {
+       WIMStruct *w;
+       const char *target;
+       int extract_flags;
+       unsigned num_lutimes_warnings;
+       struct list_head *stream_list;
+       union wimlib_progress_info progress;
+#ifdef WITH_NTFS_3G
+       struct _ntfs_volume *vol;
+#endif
+       struct list_head empty_files;
+       wimlib_progress_func_t progress_func;
+};
+
+extern int wim_apply_dentry_ntfs(struct dentry *dentry, void *arg);
+extern int wim_apply_dentry_timestamps(struct dentry *dentry, void *arg);
+
+/* ntfs-capture.c */
+extern int build_dentry_tree_ntfs(struct dentry **root_p,
+                                 const char *device,
+                                 struct lookup_table *lookup_table,
+                                 struct wim_security_data *sd,
+                                 const struct capture_config *config,
+                                 int add_image_flags,
+                                 wimlib_progress_func_t progress_func,
+                                 void *extra_arg);
 
 /* resource.c */
 extern const u8 *get_resource_entry(const u8 *p, struct resource_entry *entry);
@@ -398,9 +477,15 @@ extern u8 *put_resource_entry(u8 *p, const struct resource_entry *entry);
 extern int read_uncompressed_resource(FILE *fp, u64 offset, u64 size, u8 buf[]);
 
 extern int read_wim_resource(const struct lookup_table_entry *lte, u8 buf[],
-                            size_t size, u64 offset, bool raw);
+                            size_t size, u64 offset, int flags);
+
+extern int read_full_wim_resource(const struct lookup_table_entry *lte,
+                                 u8 buf[], int flags);
 
-extern int read_full_wim_resource(const struct lookup_table_entry *lte, u8 buf[]);
+extern int write_wim_resource(struct lookup_table_entry *lte,
+                             FILE *out_fp, int out_ctype,
+                             struct resource_entry *out_res_entry,
+                             int flags);
 
 extern int extract_wim_resource_to_fd(const struct lookup_table_entry *lte,
                                      int fd, u64 size);
@@ -419,7 +504,7 @@ extern int write_metadata_resource(WIMStruct *w);
 
 
 /* security.c */
-int read_security_data(const u8 metadata_resource[], 
+int read_security_data(const u8 metadata_resource[],
                u64 metadata_resource_len, struct wim_security_data **sd_p);
 
 void print_security_data(const struct wim_security_data *sd);
@@ -428,7 +513,7 @@ void free_security_data(struct wim_security_data *sd);
 
 /* symlink.c */
 ssize_t inode_readlink(const struct inode *inode, char *buf, size_t buf_len,
-                       const WIMStruct *w);
+                       const WIMStruct *w, int read_resource_flags);
 extern void *make_symlink_reparse_data_buf(const char *symlink_target,
                                           size_t *len_ret);
 extern int inode_set_symlink(struct inode *inode,
@@ -438,18 +523,30 @@ extern int inode_set_symlink(struct inode *inode,
 
 /* wim.c */
 extern WIMStruct *new_wim_struct();
-extern int wimlib_select_image(WIMStruct *w, int image);
+extern int select_wim_image(WIMStruct *w, int image);
 extern int wim_hdr_flags_compression_type(int wim_hdr_flags);
 extern int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
+extern int open_wim_readable(WIMStruct *w, const char *path);
+extern int open_wim_writable(WIMStruct *w, const char *path,
+                            bool trunc, bool readable);
 
-/* write.c */
-extern int finish_write(WIMStruct *w, int image, int flags, 
-                       int write_lookup_table);
+/* Internal use only */
+#define WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE      0x80000000
+#define WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE 0x40000000
+#define WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML  0x20000000
+#define WIMLIB_WRITE_MASK_PUBLIC               0x1fffffff
 
-extern int begin_write(WIMStruct *w, const char *path, int flags);
+/* Internal use only */
+#define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE                0x80000000
+#define WIMLIB_EXTRACT_FLAG_NO_STREAMS         0x40000000
+#define WIMLIB_EXTRACT_MASK_PUBLIC             0x3fffffff
 
 
-#include "wimlib.h"
+/* write.c */
+extern int begin_write(WIMStruct *w, const char *path, int write_flags);
+
+extern int finish_write(WIMStruct *w, int image, int write_flags,
+                       wimlib_progress_func_t progress_func);
 
 #endif /* _WIMLIB_INTERNAL_H */