]> wimlib.net Git - wimlib/blobdiff - src/wimlib_internal.h
WIM capture: Share inodes immediately
[wimlib] / src / wimlib_internal.h
index 68ec73f53d6d83e039df099a7dc26e09974c917d..3d7fb488f519fdc55cc4f91ba224337886d80447 100644 (file)
@@ -5,41 +5,62 @@
  */
 
 /*
- * Copyright (C) 2010 Carl Thijssen
- * Copyright (C) 2012 Eric Biggers
+ * Copyright (C) 2012, 2013 Eric Biggers
  *
  * 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/.
  */
 
 #ifndef _WIMLIB_INTERNAL_H
 #define _WIMLIB_INTERNAL_H
 
+#include "config.h"
 #include "util.h"
+#include "list.h"
+#include "wimlib.h"
 
-struct stat;
-
-#ifndef WIM_HASH_SIZE
-#define WIM_HASH_SIZE  20
+#ifdef WITH_FUSE
+#include <pthread.h>
 #endif
 
+#define WIMLIB_MAKEVERSION(major, minor, patch) \
+       ((major << 20) | (minor << 10) | patch)
+
+
+#define WIMLIB_VERSION_CODE \
+               WIMLIB_MAKEVERSION(WIMLIB_MAJOR_VERSION,\
+                                  WIMLIB_MINOR_VERSION,\
+                                  WIMLIB_PATCH_VERSION)
+
+#define WIMLIB_GET_PATCH_VERSION(version) \
+       ((version >> 0) & ((1 << 10) - 1))
+#define WIMLIB_GET_MINOR_VERSION(version) \
+       ((version >> 10) & ((1 << 10) - 1))
+#define WIMLIB_GET_MAJOR_VERSION(version) \
+       ((version >> 20) & ((1 << 10) - 1))
+
+
+struct stat;
+struct wim_dentry;
+struct wim_inode;
+struct sd_set;
+
 #define WIM_MAGIC_LEN  8
 #define WIM_GID_LEN    16
 #define WIM_UNUSED_LEN 60
 
-
 /* Length of the WIM header on disk. */
 #define WIM_HEADER_DISK_SIZE (148 + WIM_UNUSED_LEN)
 
@@ -51,12 +72,6 @@ struct stat;
  * 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,
-};
-
 /* Metadata for a resource in a WIM file. */
 struct resource_entry {
        /* Size, in bytes, of the resource in the WIM file. */
@@ -75,31 +90,37 @@ 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
 
-
 /* 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;
 
-       /* Version of the WIM file.  M$ provides no documentation about exactly
-        * what this field affects about the file format, other than the fact
-        * that more recent versions have a higher value. */
+       /* Version of the WIM file.  Microsoft provides no documentation about
+        * exactly what this field affects about the file format, other than the
+        * fact that more recent versions have a higher value. */
        //u32 version;
 
        /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
@@ -107,12 +128,12 @@ struct wim_header {
 
        /* The size of the pieces that the uncompressed files were split up into
         * when they were compressed.  This should be the same as
-        * WIM_CHUNK_SIZE.  M$ incorrectly documents this as "the size of the
-        * compressed .wim file in bytes".*/
+        * WIM_CHUNK_SIZE.  Microsoft 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];
+       u8 guid[WIM_GID_LEN];
 
        /* Part number of the WIM file in a spanned set. */
        u16 part_number;
@@ -136,7 +157,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.*/
@@ -146,35 +167,40 @@ 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$ */
+/* Reserved for future use */
 #define WIM_HDR_FLAG_RESERVED           0x00000001
 
 /* Files and metadata in the WIM are compressed. */
 #define WIM_HDR_FLAG_COMPRESSION        0x00000002
 
-/* WIM is read-only. */
+/* WIM is read-only (wimlib ignores this because it's pretty much pointless) */
 #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.  wimlib ignores this
+ * flag, as it looks for resources in all the WIMs anyway. */
 #define WIM_HDR_FLAG_RESOURCE_ONLY      0x00000010
 
-/* The WIM contains metadata only. */
+/* The WIM contains metadata only.  wimlib ignores 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. */
-#define WIM_HDR_FLAG_WRITE_IN_PROGRESS  0x00000040 
+/* Lock field to prevent multiple writers from writing the WIM concurrently.
+ * wimlib ignores this flag as it uses flock() to acquire a real lock on the
+ * file (if supported by the underlying filesystem). */
+#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.  wimlib ignores 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
@@ -185,17 +211,23 @@ struct wim_header {
  * a LZ77-based algorithm. */
 #define WIM_HDR_FLAG_COMPRESS_LZX       0x00040000
 
+#ifdef WITH_NTFS_3G
+struct _ntfs_volume;
+#endif
 
-/* Structure for security data.  Each image in the WIM file has its own security
- * data. */
+/* Table of security descriptors for a WIM image. */
 struct wim_security_data {
-       /* The total length of the security data, in bytes.  A typical size is
-        * 2048 bytes.  If there is no security data, though (as in the WIMs
-        * that wimlib writes, currently), it will be 8 bytes. */
+       /* The total length of the security data, in bytes.  If there are no
+        * security descriptors, this field, when read from the on-disk metadata
+        * resource, may be either 8 (which is correct) or 0 (which is
+        * interpreted as 0). */
        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 on-disk, 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;
@@ -203,233 +235,424 @@ struct wim_security_data {
        /* Array of descriptors. */
        u8 **descriptors;
 
-       /* keep track of how many WIMs reference this security data (used when
+       /* Keep track of how many WIMs reference this security data (used when
         * exporting images between WIMs) */
        u32 refcnt;
-} WIMSecurityData;
-
-struct link_group_table;
+};
 
+/* Metadata for a WIM image */
+struct wim_image_metadata {
 
-/* Metadata resource for an image. */
-struct image_metadata {
-       /* Pointer to the root dentry for the image. */
-       struct dentry    *root_dentry;
+       /* Pointer to the root dentry of the image. */
+       struct wim_dentry    *root_dentry;
 
-       /* Pointer to the security data for the image. */
+       /* Pointer to the security data of the image. */
        struct wim_security_data *security_data;
 
-       /* A pointer to the lookup table entry for this image's metadata
-        * resource. */
-       struct lookup_table_entry *metadata_lte;
+       /* Pointer to the lookup table entry for this image's metadata resource
+        */
+       struct wim_lookup_table_entry *metadata_lte;
 
-       /* Hard link group table */
-       struct link_group_table *lgt;
+       /* Linked list of inodes of this image */
+       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;
+       /* 1 iff the dentry tree has been modified.  If this is the case, the
+        * memory for the dentry tree should not be freed when switching to a
+        * different WIM image. */
+       u8 modified : 1;
 
+       /* 1 iff this image has been mounted read-write */
+       u8 has_been_mounted_rw : 1;
 };
 
 /* The opaque structure exposed to the wimlib API. */
-typedef struct WIMStruct {
+struct WIMStruct {
 
        /* A pointer to the file indicated by @filename, opened for reading. */
-       FILE                *fp;
+       FILE *fp;
 
-       /* FILE pointer for the WIM file that is being written. */
-       FILE  *out_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
 
-       /* The name of the WIM file that has been opened. */
-       char                *filename;
+       /* FILE pointer for the WIM file (if any) currently being written. */
+       FILE *out_fp;
 
-       /* The lookup table for the WIM file. */ 
-       struct lookup_table *lookup_table;
+       /* The name of the WIM file (if any) that has been opened. */
+       tchar *filename;
 
-       /* Pointer to the XML data read from the WIM file. */
-       u8                  *xml_data;
+       /* The lookup table for the WIM file. */
+       struct wim_lookup_table *lookup_table;
 
-       /* Information retrieved from the XML data, arranged
-        * in an orderly manner. */
-       struct wim_info      *wim_info;
+       /* Pointer to the XML data read from the WIM file (UTF16LE-encoded). */
+       utf16lechar *xml_data;
 
-       /* 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;
+       /* Information retrieved from the XML data, arranged in an orderly
+        * manner. */
+       struct wim_info *wim_info;
 
-       /* Name of the output directory for extraction. */
-       char  *output_dir;
+       /* Array of the image metadata, one for each image in the WIM. */
+       struct wim_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. */
-       union {
-               int extract_flags;
-               int add_flags;
-       };
+       /* Temporary field */
+       void *private;
+
+#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
         * image_metadata array. */
        int current_image;
 
-       union {
-               /* Set to true when extracting multiple images */
-               bool is_multi_image_extraction;
-
-               bool write_metadata;
-       };
-} WIMStruct;
-
+       u8 deletion_occurred : 1;
+       u8 all_images_verified : 1;
+       u8 wim_locked : 1;
+};
 
 /* Inline utility functions for WIMStructs. */
 
-static inline struct dentry *wim_root_dentry(WIMStruct *w)
+static inline struct wim_dentry *
+wim_root_dentry(WIMStruct *w)
 {
        return w->image_metadata[w->current_image - 1].root_dentry;
 }
 
-static inline struct dentry **wim_root_dentry_p(WIMStruct *w)
+static inline struct wim_security_data *
+wim_security_data(WIMStruct *w)
 {
-       return &w->image_metadata[w->current_image - 1].root_dentry;
+       return w->image_metadata[w->current_image - 1].security_data;
 }
-
-static inline struct wim_security_data *wim_security_data(WIMStruct *w)
+static inline const struct wim_security_data *
+wim_const_security_data(const WIMStruct *w)
 {
        return w->image_metadata[w->current_image - 1].security_data;
 }
 
-static inline struct lookup_table_entry*
-wim_metadata_lookup_table_entry(WIMStruct *w)
+static inline struct wim_image_metadata *
+wim_get_current_image_metadata(WIMStruct *w)
 {
-       return w->image_metadata[w->current_image - 1].metadata_lte;
+       return &w->image_metadata[w->current_image - 1];
 }
 
 /* Nonzero if a struct resource_entry indicates a compressed resource. */
-static inline int resource_is_compressed(const struct resource_entry *entry)
+static inline int
+resource_is_compressed(const struct resource_entry *entry)
 {
        return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
 }
 
-static inline struct image_metadata *wim_get_current_image_metadata(WIMStruct *w)
-{
-       return &w->image_metadata[w->current_image - 1];
-}
+/* add_image.c */
 
-/* Prints a hash code field. */
-static inline void print_hash(const u8 hash[])
-{
-       print_byte_field(hash, WIM_HASH_SIZE);
-}
+extern bool
+exclude_path(const tchar *path, size_t path_len,
+            const struct wimlib_capture_config *config,
+            bool exclude_prefix);
+
+extern int
+add_new_dentry_tree(WIMStruct *dest_wim, struct wim_dentry *root,
+                   struct wim_security_data *sd);
+
+
+/* extract_image.c */
+
+/* Internal use only */
+#define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE                0x80000000
+#define WIMLIB_EXTRACT_FLAG_NO_STREAMS         0x40000000
+#define WIMLIB_EXTRACT_MASK_PUBLIC             0x3fffffff
 
 /* hardlink.c */
 
-struct link_group_table *new_link_group_table(u64 capacity);
-int link_group_table_insert(struct dentry *dentry,
-                           struct link_group_table *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, given an inode number (in the case of reading
+ * a WIM images), or both an inode number and a device number (in the case of
+ * capturing a WIM image). */
+struct wim_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.
+         *
+        * - Groups we create ourselves by splitting a nominal inode due to
+        *   inconsistencies in the dentries.  These inodes will share an inode
+        *   number with some other inode until assign_inode_numbers() is
+        *   called.
+        */
+       struct hlist_head extra_inodes;
+};
+
+extern int
+init_inode_table(struct wim_inode_table *table, size_t capacity);
+
+extern int
+inode_table_new_dentry(struct wim_inode_table *table, const tchar *name,
+                      u64 ino, u64 devno, struct wim_dentry **dentry_ret);
+
+extern void
+inode_table_prepare_inode_list(struct wim_inode_table *table,
+                              struct hlist_head *head);
+
+static inline void
+destroy_inode_table(struct wim_inode_table *table)
+{
+       FREE(table->array);
+}
+
 
+extern int
+dentry_tree_fix_inodes(struct wim_dentry *root, struct hlist_head *inode_list);
 
 /* header.c */
-extern int read_header(FILE *fp, struct wim_header *hdr, int split_ok);
-extern int write_header(const struct wim_header *hdr, FILE *out);
-extern int init_header(struct wim_header *hdr, int ctype);
+
+extern int
+read_header(FILE *fp, struct wim_header *hdr, int split_ok);
+
+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);
 
-/* modify.c */
-extern void destroy_image_metadata(struct image_metadata *imd,
-                                  struct lookup_table *lt);
+#define WIM_INTEGRITY_OK 0
+#define WIM_INTEGRITY_NOT_OK -1
+#define WIM_INTEGRITY_NONEXISTENT -2
+
+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 */
+
+extern int
+new_joined_lookup_table(WIMStruct *w, WIMStruct **additional_swms,
+                       unsigned num_additional_swms,
+                       struct wim_lookup_table **table_ret);
+
+/* metadata_resource.c */
+
+extern int
+read_metadata_resource(WIMStruct *w,
+                                 struct wim_image_metadata *image_metadata);
+
+extern int
+write_metadata_resource(WIMStruct *w);
+
+/* ntfs-apply.c */
+
+struct apply_args {
+       WIMStruct *w;
+       const tchar *target;
+       int extract_flags;
+       union wimlib_progress_info progress;
+       wimlib_progress_func_t progress_func;
+       int (*apply_dentry)(struct wim_dentry *, void *);
+       union {
+       #ifdef WITH_NTFS_3G
+               struct {
+                       /* NTFS apply only */
+                       struct _ntfs_volume *vol;
+               };
+       #endif
+               struct {
+                       /* Normal apply only (UNIX) */
+                       unsigned long num_utime_warnings;
+               };
+
+               struct {
+                       /* Normal apply only (Win32) */
+                       unsigned long num_set_sacl_priv_notheld;
+                       unsigned long num_set_sd_access_denied;
+               };
+       };
+};
+
+extern int
+apply_dentry_ntfs(struct wim_dentry *dentry, void *arg);
+
+extern int
+apply_dentry_timestamps_ntfs(struct wim_dentry *dentry, void *arg);
+
+extern void
+libntfs3g_global_init();
+
+/* ntfs-capture.c */
+extern int
+build_dentry_tree_ntfs(struct wim_dentry **root_p,
+                      const tchar *device,
+                      struct wim_lookup_table *lookup_table,
+                      struct wim_inode_table *inode_table,
+                      struct sd_set *sd_set,
+                      const struct wimlib_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);
-extern u8 *put_resource_entry(u8 *p, const struct resource_entry *entry);
 
-extern int read_resource(FILE *fp, u64 resource_size, 
-                        u64 resource_original_size,
-                        u64 resource_offset, int resource_ctype, u64 len, 
-                        u64 offset, void *contents_ret);
+#define WIMLIB_RESOURCE_FLAG_RAW               0x1
+#define WIMLIB_RESOURCE_FLAG_MULTITHREADED     0x2
+#define WIMLIB_RESOURCE_FLAG_RECOMPRESS                0x4
+
+extern const u8 *
+get_resource_entry(const u8 *p, struct resource_entry *entry);
+
+extern u8 *
+put_resource_entry(u8 *p, const struct resource_entry *entry);
 
-extern int read_uncompressed_resource(FILE *fp, u64 offset, u64 len, 
-                                       u8 contents_ret[]);
+extern int
+read_uncompressed_resource(FILE *fp, u64 offset, u64 size, void *buf);
 
+extern int
+read_wim_resource(const struct wim_lookup_table_entry *lte, void *buf,
+                 size_t size, u64 offset, int flags);
 
-extern int extract_resource_to_fd(WIMStruct *w, 
-                                 const struct resource_entry *entry, 
-                                 int fd, 
-                                 u64 size);
+extern int
+read_full_wim_resource(const struct wim_lookup_table_entry *lte,
+                      void *buf, int flags);
 
-extern int extract_full_resource_to_fd(WIMStruct *w, 
-                                      const struct resource_entry *entry, 
-                                      int fd);
+extern int
+write_wim_resource(struct wim_lookup_table_entry *lte, FILE *out_fp,
+                  int out_ctype, struct resource_entry *out_res_entry,
+                  int flags);
 
-extern int read_metadata_resource(FILE *fp, int wim_ctype, 
-                                 struct image_metadata *image_metadata);
 
-extern int resource_compression_type(int wim_ctype, int reshdr_flags);
+typedef int (*extract_chunk_func_t)(const void *, size_t, u64, void *);
 
-static inline int read_full_resource(FILE *fp, u64 resource_size, 
-                                    u64 resource_original_size,
-                                    u64 resource_offset, 
-                                    int resource_ctype, void *contents_ret)
+extern int
+extract_wim_chunk_to_fd(const void *buf, size_t len, u64 offset, void *arg);
+
+extern int
+extract_wim_resource(const struct wim_lookup_table_entry *lte,
+                    u64 size, extract_chunk_func_t extract_chunk,
+                    void *extract_chunk_arg);
+
+/*
+ * Extracts the first @size bytes of the WIM resource specified by @lte to the
+ * open file descriptor @fd.
+ *
+ * Returns 0 on success; nonzero on failure.
+ */
+static inline int
+extract_wim_resource_to_fd(const struct wim_lookup_table_entry *lte,
+                          int fd, u64 size)
 {
-       return read_resource(fp, resource_size, resource_original_size, 
-                               resource_offset, resource_ctype,
-                               resource_original_size, 0, contents_ret);
+       return extract_wim_resource(lte, size,
+                                   extract_wim_chunk_to_fd, &fd);
 }
 
-extern int write_dentry_resources(struct dentry *dentry, void *wim_p);
-extern int copy_resource(struct lookup_table_entry *lte, void *w);
-extern int copy_between_files(FILE *in, off_t in_offset, FILE *out, size_t len);
-extern int write_resource_from_memory(const u8 resource[], int out_ctype,
-                                     u64 resource_original_size, FILE *out,
-                                     u64 *resource_size_ret);
-extern int write_metadata_resource(WIMStruct *w);
+
+extern int
+write_dentry_resources(struct wim_dentry *dentry, void *wim_p);
+
+extern int
+copy_resource(struct wim_lookup_table_entry *lte, void *w);
 
 
 /* security.c */
-int read_security_data(const u8 metadata_resource[], 
-               u64 metadata_resource_len, struct wim_security_data **sd_p);
+extern int
+read_security_data(const u8 metadata_resource[],
+                  u64 metadata_resource_len, struct wim_security_data **sd_p);
+extern void
+print_security_data(const struct wim_security_data *sd);
+
+extern u8 *
+write_security_data(const struct wim_security_data *sd, u8 *p);
 
-void print_security_data(const struct wim_security_data *sd);
-u8 *write_security_data(const struct wim_security_data *sd, u8 *p);
-void free_security_data(struct wim_security_data *sd);
+extern 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,
-                       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);
+
+#ifndef __WIN32__
+ssize_t
+inode_readlink(const struct wim_inode *inode, char *buf, size_t buf_len,
+              const WIMStruct *w, int read_resource_flags);
+
+extern int
+inode_set_symlink(struct wim_inode *inode, const char *target,
+                 struct wim_lookup_table *lookup_table,
+                 struct wim_lookup_table_entry **lte_ret);
+#endif
+
+/* verify.c */
+
+extern int
+verify_dentry(struct wim_dentry *dentry, void *wim);
+
+extern int
+wim_run_full_verifications(WIMStruct *w);
+
+extern int
+verify_swm_set(WIMStruct *w,
+              WIMStruct **additional_swms, unsigned num_additional_swms);
 
 /* wim.c */
-extern WIMStruct *new_wim_struct();
-extern int wimlib_select_image(WIMStruct *w, int image);
-extern int wim_hdr_flags_compression_type(int wim_hdr_flags);
-extern int wim_resource_compression_type(const WIMStruct *w, 
-                                        const struct resource_entry *entry);
-extern int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
+
+extern int
+select_wim_image(WIMStruct *w, int image);
+
+extern int
+for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
+
+extern void
+destroy_image_metadata(struct wim_image_metadata *imd,
+                      struct wim_lookup_table *lt);
 
 /* write.c */
-extern int finish_write(WIMStruct *w, int image, int flags, 
-                       int write_lookup_table);
 
-extern int begin_write(WIMStruct *w, const char *path, int flags);
+/* 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
 
+/* We are capturing a tree to be placed in the root of the WIM image */
+#define WIMLIB_ADD_IMAGE_FLAG_ROOT     0x80000000
 
-#include "wimlib.h"
+/* We are capturing a dentry that will become the root of a tree to be added to
+ * the WIM image */
+#define WIMLIB_ADD_IMAGE_FLAG_SOURCE    0x40000000
+
+
+extern int
+begin_write(WIMStruct *w, const tchar *path, int write_flags);
+
+extern void
+close_wim_writable(WIMStruct *w);
+
+extern int
+finish_write(WIMStruct *w, int image, int write_flags,
+            wimlib_progress_func_t progress_func);
+
+#if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
+extern int
+lock_wim(WIMStruct *w, FILE *fp);
+#else
+static inline int
+lock_wim(WIMStruct *w, FILE *fp)
+{
+       return 0;
+}
+#endif
 
 #endif /* _WIMLIB_INTERNAL_H */