]> wimlib.net Git - wimlib/blobdiff - src/wimlib_internal.h
wimfs_link(), wimfs_symlink(), symlink fixes
[wimlib] / src / wimlib_internal.h
index 269f0a5b2898bd27a0803800d1fa7cbeb7886ab4..d9c7775647063c3e3732c71338bd66b302ca874d 100644 (file)
@@ -2,24 +2,26 @@
  * wimlib_internal.h
  *
  * Internal header for wimlib.
- *
- * wimlib - Library for working with WIM files 
- *
+ */
+
+/*
  * Copyright (C) 2010 Carl Thijssen
  * Copyright (C) 2012 Eric Biggers
  *
- * This library 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) any
- * later version.
+ * This file is part of wimlib, a library for working with WIM files.
  *
- * This library 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 details.
+ * 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)
+ * any later version.
  *
- * You should have received a copy of the GNU Lesser General Public License along
- * with this library; if not, write to the Free Software Foundation, Inc., 59
- * Temple Place, Suite 330, Boston, MA 02111-1307 USA 
+ * 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
+ * details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with wimlib; if not, see http://www.gnu.org/licenses/.
  */
 
 #ifndef _WIMLIB_INTERNAL_H
 
 struct stat;
 
+#ifndef WIM_HASH_SIZE
 #define WIM_HASH_SIZE  20
+#endif
+
 #define WIM_MAGIC_LEN  8
 #define WIM_GID_LEN    16
 #define WIM_UNUSED_LEN 60
@@ -42,8 +47,8 @@ struct stat;
  * of this size. */
 #define WIM_CHUNK_SIZE 32768
 
-/* Version of the WIM file.  I don't know if there has ever been a different
- * version or not. */
+/* Version of the WIM file.  There is an older version, but we don't support it
+ * yet.  The differences between the versions are undocumented. */
 #define WIM_VERSION 0x10d00
 
 enum wim_integrity_status {
@@ -181,10 +186,9 @@ struct wim_header {
 #define WIM_HDR_FLAG_COMPRESS_LZX       0x00040000
 
 
-#if 0
 /* Structure for security data.  Each image in the WIM file has its own security
  * data. */
-typedef struct WIMSecurityData {
+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. */
@@ -198,49 +202,52 @@ typedef struct WIMSecurityData {
 
        /* Array of descriptors. */
        u8 **descriptors;
+
+       /* keep track of how many WIMs reference this security data (used when
+        * exporting images between WIMs) */
+       u32 refcnt;
 } WIMSecurityData;
-#endif
+
+struct link_group_table;
+
 
 /* Metadata resource for an image. */
 struct image_metadata {
+       /* Pointer to the root dentry for the image. */
+       struct dentry    *root_dentry;
 
-#if 0
-       /* The security data for the image. */
-       WIMSecurityData      security_data;
-#endif
+       /* Pointer to the security data for the image. */
+       struct wim_security_data *security_data;
 
-       /* The root dentry for the image. */
-       struct dentry    *root_dentry;
+       /* A pointer to the lookup table entry for this image's metadata
+        * resource. */
+       struct lookup_table_entry *metadata_lte;
+
+       /* Hard link group table */
+       struct link_group_table *lgt;
 
        /* 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;
 
-       /* A pointer to the lookup table entry for this image's metadata
-        * resource. */
-       struct lookup_table_entry *lookup_table_entry;
 };
 
 /* The opaque structure exposed to the wimlib API. */
 typedef struct WIMStruct {
-       /* The name of the WIM file that has been opened. */
-       char                *filename;
 
        /* A pointer to the file indicated by @filename, opened for reading. */
        FILE                *fp;
 
-       /* 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;
+       /* FILE pointer for the WIM file that is being written. */
+       FILE  *out_fp;
+
+       /* The name of the WIM file that has been opened. */
+       char                *filename;
 
        /* The lookup table for the WIM file. */ 
        struct lookup_table *lookup_table;
 
-       /* The header of the WIM file. */
-       struct wim_header    hdr;
-
        /* Pointer to the XML data read from the WIM file. */
        u8                  *xml_data;
 
@@ -252,22 +259,30 @@ typedef struct WIMStruct {
         * WIM has a image metadata associated with it. */
        struct image_metadata     *image_metadata;
 
-       /* True if files names are to be printed when doing extraction. 
-        * May be used for other things later. */
-       bool   verbose;
-
-       /* The type of links to create when extracting files (hard, symbolic, or
-        * none.) */
-       int    link_type;
-
        /* Name of the output directory for extraction. */
        char  *output_dir;
 
-       /* Set to true when extracting multiple images */
-       bool   is_multi_image_extraction;
+       /* The header of the WIM file. */
+       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;
+       };
 
-       /* FILE pointer for the WIM file that is being written. */
-       FILE  *out_fp;
+       /* 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;
 
 
@@ -283,17 +298,15 @@ static inline struct dentry **wim_root_dentry_p(WIMStruct *w)
        return &w->image_metadata[w->current_image - 1].root_dentry;
 }
 
-#if 0
-static inline WIMSecurityData *wim_security_data(WIMStruct *w)
+static inline struct wim_security_data *wim_security_data(WIMStruct *w)
 {
-       return &w->image_metadata[w->current_image - 1].security_data;
+       return w->image_metadata[w->current_image - 1].security_data;
 }
-#endif
 
 static inline struct lookup_table_entry*
 wim_metadata_lookup_table_entry(WIMStruct *w)
 {
-       return w->image_metadata[w->current_image - 1].lookup_table_entry;
+       return w->image_metadata[w->current_image - 1].metadata_lte;
 }
 
 /* Nonzero if a struct resource_entry indicates a compressed resource. */
@@ -307,17 +320,20 @@ static inline struct image_metadata *wim_get_current_image_metadata(WIMStruct *w
        return &w->image_metadata[w->current_image - 1];
 }
 
-static inline bool wim_current_image_is_modified(const WIMStruct *w)
-{
-       return w->image_metadata[w->current_image - 1].modified;
-}
-
 /* Prints a hash code field. */
 static inline void print_hash(const u8 hash[])
 {
        print_byte_field(hash, WIM_HASH_SIZE);
 }
 
+/* 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);
+
 
 /* header.c */
 extern int read_header(FILE *fp, struct wim_header *hdr, int split_ok);
@@ -330,6 +346,9 @@ 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);
 
+/* modify.c */
+extern void destroy_image_metadata(struct image_metadata *imd,
+                                  struct lookup_table *lt);
 
 /* resource.c */
 extern const u8 *get_resource_entry(const u8 *p, struct resource_entry *entry);
@@ -353,32 +372,46 @@ extern int extract_full_resource_to_fd(WIMStruct *w,
                                       const struct resource_entry *entry, 
                                       int fd);
 
-extern int read_metadata_resource(FILE *fp, const struct resource_entry *metadata,
-                             int wim_ctype, /* WIMSecurityData *sd, */
-                             struct dentry **root_dentry_p);
+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);
 
 static inline int read_full_resource(FILE *fp, u64 resource_size, 
-                               u64 resource_original_size,
-                               u64 resource_offset, 
-                               int resource_ctype, void *contents_ret)
+                                    u64 resource_original_size,
+                                    u64 resource_offset, 
+                                    int resource_ctype, void *contents_ret)
 {
        return read_resource(fp, resource_size, resource_original_size, 
                                resource_offset, resource_ctype,
                                resource_original_size, 0, contents_ret);
 }
 
-#if 0
-/* security.c */
-bool read_security_data(const u8 metadata_resource[], 
-               u64 metadata_resource_len, WIMSecurityData *sd);
+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);
 
-void print_security_data(const WIMSecurityData *sd);
-u8 *write_security_data(const WIMSecurityData *sd, u8 *p);
-void init_security_data(WIMSecurityData *sd);
-void destroy_security_data(WIMSecurityData *sd);
-#endif
+
+/* security.c */
+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);
+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,
+                       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);
 
 /* wim.c */
 extern WIMStruct *new_wim_struct();
@@ -391,13 +424,8 @@ extern int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
 /* write.c */
 extern int finish_write(WIMStruct *w, int image, int flags, 
                        int write_lookup_table);
-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 begin_write(WIMStruct *w, const char *path, int flags);
-extern int write_metadata_resource(WIMStruct *w);
 
 
 #include "wimlib.h"