wimlib.net Git - wimlib/blob - src/wimlib_internal.h

   1 /*
   2  * wimlib_internal.h
   3  *
   4  * Internal header for wimlib.
   5  */
   6
   7 /*
   8  * Copyright (C) 2010 Carl Thijssen
   9  * Copyright (C) 2012 Eric Biggers
  10  *
  11  * This file is part of wimlib, a library for working with WIM files.
  12  *
  13  * wimlib is free software; you can redistribute it and/or modify it under the
  14  * terms of the GNU General Public License as published by the Free
  15  * Software Foundation; either version 3 of the License, or (at your option)
  16  * any later version.
  17  *
  18  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  19  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  20  * A PARTICULAR PURPOSE. See the GNU General Public License for more
  21  * details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  25  */
  26
  27 #ifndef _WIMLIB_INTERNAL_H
  28 #define _WIMLIB_INTERNAL_H
  29
  30 #include "util.h"
  31 #include "list.h"
  32
  33 struct stat;
  34 struct dentry;
  35 struct inode;
  36
  37 #define WIM_MAGIC_LEN  8
  38 #define WIM_GID_LEN    16
  39 #define WIM_UNUSED_LEN 60
  40
  41
  42 /* Length of the WIM header on disk. */
  43 #define WIM_HEADER_DISK_SIZE (148 + WIM_UNUSED_LEN)
  44
  45 /* Compressed resources in the WIM are divided into separated compressed chunks
  46  * of this size. */
  47 #define WIM_CHUNK_SIZE 32768
  48
  49 /* Version of the WIM file.  There is an older version, but we don't support it
  50  * yet.  The differences between the versions are undocumented. */
  51 #define WIM_VERSION 0x10d00
  52
  53 enum wim_integrity_status {
  54         WIM_INTEGRITY_OK,
  55         WIM_INTEGRITY_NOT_OK,
  56         WIM_INTEGRITY_NONEXISTENT,
  57 };
  58
  59 /* Metadata for a resource in a WIM file. */
  60 struct resource_entry {
  61         /* Size, in bytes, of the resource in the WIM file. */
  62         u64 size  : 56;
  63
  64         /* Bitwise or of one or more of the WIM_RESHDR_FLAG_* flags. */
  65         u64 flags : 8;
  66
  67         /* Offset, in bytes, of the resource in the WIM file. */
  68         u64 offset;
  69
  70         /* Uncompressed size of the resource in the WIM file.  Is the same as
  71          * @size if the resource is uncompressed. */
  72         u64 original_size;
  73 };
  74
  75 /* Flags for the `flags' field of the struct resource_entry structure. */
  76
  77 /* I haven't seen this flag used in any of the WIMs I have examined.  I assume
  78  * it means that there are no references to the stream, so the space is free.
  79  * However, even after deleting files from a WIM mounted with `imagex.exe
  80  * /mountrw', I could not see this flag being used.  Either way, we don't
  81  * actually use this flag for anything. */
  82 #define WIM_RESHDR_FLAG_FREE            0x01
  83
  84 /* Indicates that the stream is a metadata resource for a WIM image. */
  85 #define WIM_RESHDR_FLAG_METADATA        0x02
  86
  87 /* Indicates that the stream is compressed. */
  88 #define WIM_RESHDR_FLAG_COMPRESSED      0x04
  89
  90 /* I haven't seen this flag used in any of the WIMs I have examined.  Perhaps it
  91  * means that a stream could possibly be split among multiple split WIM parts.
  92  * However, `imagex.exe /split' does not seem to create any WIMs like this.
  93  * Either way, we don't actually use this flag for anything.  */
  94 #define WIM_RESHDR_FLAG_SPANNED         0x08
  95
  96
  97 /* Header at the very beginning of the WIM file. */
  98 struct wim_header {
  99         /* Identifies the file as WIM file. Must be exactly
 100          * {'M', 'S', 'W', 'I', 'M', 0, 0, 0}  */
 101         //u8  magic[WIM_MAGIC_LEN];
 102
 103         /* size of WIM header in bytes. */
 104         //u32 hdr_size;
 105
 106         /* Version of the WIM file.  M$ provides no documentation about exactly
 107          * what this field affects about the file format, other than the fact
 108          * that more recent versions have a higher value. */
 109         //u32 version;
 110
 111         /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
 112         u32 flags;
 113
 114         /* The size of the pieces that the uncompressed files were split up into
 115          * when they were compressed.  This should be the same as
 116          * WIM_CHUNK_SIZE.  M$ incorrectly documents this as "the size of the
 117          * compressed .wim file in bytes".*/
 118         //u32 chunk_size;
 119
 120         /* A unique identifier for the WIM file. */
 121         u8  guid[WIM_GID_LEN];
 122
 123         /* Part number of the WIM file in a spanned set. */
 124         u16 part_number;
 125
 126         /* Total number of parts in a spanned set. */
 127         u16 total_parts;
 128
 129         /* Number of images in the WIM file. */
 130         u32 image_count;
 131
 132         /* Location, size, and flags of the lookup table of the WIM. */
 133         struct resource_entry lookup_table_res_entry;
 134
 135         /* Location, size, and flags for the XML data of the WIM. */
 136         struct resource_entry xml_res_entry;
 137
 138         /* Location, size, and flags for the boot metadata.  This means the
 139          * metadata resource for the image specified by boot_idx below.  Should
 140          * be zeroed out if boot_idx is 0. */
 141         struct resource_entry boot_metadata_res_entry;
 142
 143         /* The index of the bootable image in the WIM file. If 0, there are no
 144          * bootable images available. */
 145         u32 boot_idx;
 146
 147         /* The location of the optional integrity table used to verify the
 148          * integrity WIM.  Zeroed out if there is no integrity table.*/
 149         struct resource_entry integrity;
 150
 151         /* Reserved for future disuse */
 152         //u8 unused[WIM_UNUSED_LEN];
 153 };
 154
 155 /* Flags for the `flags' field of the struct wim_header: */
 156
 157 /* Reserved for future use by M$ */
 158 #define WIM_HDR_FLAG_RESERVED           0x00000001
 159
 160 /* Files and metadata in the WIM are compressed. */
 161 #define WIM_HDR_FLAG_COMPRESSION        0x00000002
 162
 163 /* WIM is read-only (we ignore this). */
 164 #define WIM_HDR_FLAG_READONLY           0x00000004
 165
 166 /* Resource data specified by images in this WIM may be contained in a different
 167  * WIM.  Or in other words, this WIM is part of a split WIM.  */
 168 #define WIM_HDR_FLAG_SPANNED            0x00000008
 169
 170 /* The WIM contains resources only; no filesystem metadata.  We ignore this
 171  * flag, as we look for file resources in all the WIMs anyway. */
 172 #define WIM_HDR_FLAG_RESOURCE_ONLY      0x00000010
 173
 174 /* The WIM contains metadata only.  We ignore this flag.  Note that all the
 175  * metadata resources for a split WIM should be in the first part. */
 176 #define WIM_HDR_FLAG_METADATA_ONLY      0x00000020
 177
 178 /* Lock field to prevent multiple writers from writing the WIM concurrently.  We
 179  * ignore this flag. */
 180 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS  0x00000040
 181
 182 /* Reparse point fixup ???
 183  * This has something to do with absolute targets of reparse points / symbolic
 184  * links but I don't know what.  We ignore this flag.  */
 185 #define WIM_HDR_FLAG_RP_FIX             0x00000080
 186
 187 /* Unused, reserved flag for another compression type */
 188 #define WIM_HDR_FLAG_COMPRESS_RESERVED  0x00010000
 189
 190 /* Resources within the WIM are compressed using "XPRESS" compression, which is
 191  * a LZ77-based compression algorithm. */
 192 #define WIM_HDR_FLAG_COMPRESS_XPRESS    0x00020000
 193
 194 /* Resources within the WIM are compressed using "LZX" compression.  This is also
 195  * a LZ77-based algorithm. */
 196 #define WIM_HDR_FLAG_COMPRESS_LZX       0x00040000
 197
 198 #ifdef WITH_NTFS_3G
 199 struct _ntfs_volume;
 200 #endif
 201
 202 /* Structure for security data.  Each image in the WIM file has its own security
 203  * data. */
 204 struct wim_security_data {
 205         /* The total length of the security data, in bytes.  A typical size is
 206          * 2048 bytes.  If there is no security data, though (as in the WIMs
 207          * that wimlib writes, currently), it will be 8 bytes. */
 208         u32 total_length;
 209
 210         /* The number of security descriptors in the array @descriptors, below.
 211          * It is really an unsigned int, but it must fit into an int because the
 212          * security ID's are signed.  (Not like you would ever have more than a
 213          * few hundred security descriptors anyway). */
 214         int32_t num_entries;
 215
 216         /* Array of sizes of the descriptors in the array @descriptors. */
 217         u64 *sizes;
 218
 219         /* Array of descriptors. */
 220         u8 **descriptors;
 221
 222         /* keep track of how many WIMs reference this security data (used when
 223          * exporting images between WIMs) */
 224         u32 refcnt;
 225 };
 226
 227 struct inode_table;
 228
 229
 230 /* Metadata resource for an image. */
 231 struct image_metadata {
 232         /* Pointer to the root dentry for the image. */
 233         struct dentry    *root_dentry;
 234
 235         /* Pointer to the security data for the image. */
 236         struct wim_security_data *security_data;
 237
 238         /* A pointer to the lookup table entry for this image's metadata
 239          * resource. */
 240         struct lookup_table_entry *metadata_lte;
 241
 242         /* True if the filesystem of the image has been modified.  If this is
 243          * the case, the memory for the filesystem is not freed when switching
 244          * to a different WIM image. */
 245         bool modified;
 246
 247 };
 248
 249 /* The opaque structure exposed to the wimlib API. */
 250 typedef struct WIMStruct {
 251
 252         /* A pointer to the file indicated by @filename, opened for reading. */
 253         FILE  *fp;
 254
 255         /* FILE pointer for the WIM file that is being written. */
 256         FILE  *out_fp;
 257
 258         /* The name of the WIM file that has been opened. */
 259         char  *filename;
 260
 261         /* The lookup table for the WIM file. */
 262         struct lookup_table *lookup_table;
 263
 264         /* Pointer to the XML data read from the WIM file. */
 265         u8    *xml_data;
 266
 267         /* Information retrieved from the XML data, arranged
 268          * in an orderly manner. */
 269         struct wim_info      *wim_info;
 270
 271         /* Array of the image metadata of length image_count.  Each image in the
 272          * WIM has a image metadata associated with it. */
 273         struct image_metadata     *image_metadata;
 274
 275         /* The header of the WIM file. */
 276         struct wim_header    hdr;
 277
 278         /* Temporary flags to use when extracting a WIM image or adding a WIM
 279          * image. */
 280         union {
 281                 int extract_flags;
 282                 int add_flags;
 283                 int write_flags;
 284                 bool write_metadata;
 285         };
 286 #ifdef WITH_NTFS_3G
 287         struct _ntfs_volume *ntfs_vol;
 288 #endif
 289
 290         /* The currently selected image, indexed starting at 1.  If not 0,
 291          * subtract 1 from this to get the index of the current image in the
 292          * image_metadata array. */
 293         int current_image;
 294 } WIMStruct;
 295
 296
 297 /* Inline utility functions for WIMStructs. */
 298
 299 static inline struct dentry *wim_root_dentry(WIMStruct *w)
 300 {
 301         return w->image_metadata[w->current_image - 1].root_dentry;
 302 }
 303
 304 static inline struct wim_security_data *
 305 wim_security_data(WIMStruct *w)
 306 {
 307         return w->image_metadata[w->current_image - 1].security_data;
 308 }
 309 static inline const struct wim_security_data *
 310 wim_const_security_data(const WIMStruct *w)
 311 {
 312         return w->image_metadata[w->current_image - 1].security_data;
 313 }
 314
 315 static inline struct lookup_table_entry*
 316 wim_metadata_lookup_table_entry(WIMStruct *w)
 317 {
 318         return w->image_metadata[w->current_image - 1].metadata_lte;
 319 }
 320
 321 /* Nonzero if a struct resource_entry indicates a compressed resource. */
 322 static inline int resource_is_compressed(const struct resource_entry *entry)
 323 {
 324         return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
 325 }
 326
 327 static inline struct image_metadata *
 328 wim_get_current_image_metadata(WIMStruct *w)
 329 {
 330         return &w->image_metadata[w->current_image - 1];
 331 }
 332
 333 struct pattern_list {
 334         const char **pats;
 335         size_t num_pats;
 336         size_t num_allocated_pats;
 337 };
 338
 339 struct capture_config {
 340         struct pattern_list exclusion_list;
 341         struct pattern_list exclusion_exception;
 342         struct pattern_list compression_exclusion_list;
 343         struct pattern_list alignment_list;
 344         char *config_str;
 345         char *prefix;
 346         size_t prefix_len;
 347 };
 348
 349 /* hardlink.c */
 350
 351 /* Hash table to find inodes, identified by their inode ID.
 352  * */
 353 struct inode_table {
 354         /* Fields for the hash table */
 355         struct hlist_head *array;
 356         u64 num_entries;
 357         u64 capacity;
 358
 359         /*
 360          * Linked list of "extra" inodes.  These may be:
 361          *
 362          * - inodes with link count 1, which are all allowed to have 0 for their
 363          *   inode number, meaning we cannot insert them into the hash table
 364          *   before calling assign_inode_numbers().
 365          *
 366          * - Groups we create ourselves by splitting a nominal inode due to
 367          *   inconsistencies in the dentries.  These inodes will share a inode
 368          *   ID with some other inode until assign_inode_numbers() is called.
 369          */
 370         struct hlist_head extra_inodes;
 371 };
 372
 373 int init_inode_table(struct inode_table *table, size_t capacity);
 374 static inline void destroy_inode_table(struct inode_table *table)
 375 {
 376         FREE(table->array);
 377 }
 378 int inode_table_insert(struct dentry *dentry, void *__table);
 379 u64 assign_inode_numbers(struct hlist_head *inode_list);
 380 int fix_inodes(struct inode_table *table, struct hlist_head *inode_list);
 381
 382
 383 /* header.c */
 384 extern int read_header(FILE *fp, struct wim_header *hdr, int split_ok);
 385 extern int write_header(const struct wim_header *hdr, FILE *out);
 386 extern int init_header(struct wim_header *hdr, int ctype);
 387
 388 /* integrity.c */
 389 extern int write_integrity_table(FILE *out, u64 end_header_offset,
 390                                  u64 end_lookup_table_offset,
 391                                  int show_progress);
 392 extern int check_wim_integrity(WIMStruct *w, int show_progress, int *status);
 393
 394 /* join.c */
 395
 396 extern int new_joined_lookup_table(WIMStruct *w,
 397                                    WIMStruct **additional_swms,
 398                                    unsigned num_additional_swms,
 399                                    struct lookup_table **table_ret);
 400
 401 extern int verify_swm_set(WIMStruct *w,
 402                           WIMStruct **additional_swms,
 403                           unsigned num_additional_swms);
 404 /* modify.c */
 405 extern void destroy_image_metadata(struct image_metadata *imd,
 406                                    struct lookup_table *lt);
 407 extern bool exclude_path(const char *path,
 408                          const struct capture_config *config,
 409                          bool exclude_prefix);
 410 extern int do_add_image(WIMStruct *w, const char *dir, const char *name,
 411                         const char *config_str, size_t config_len,
 412                         int flags,
 413                         int (*capture_tree)(struct dentry **, const char *,
 414                                      struct lookup_table *,
 415                                      struct wim_security_data *,
 416                                      const struct capture_config *,
 417                                      int, void *),
 418                         void *extra_arg);
 419
 420 /* resource.c */
 421 extern const u8 *get_resource_entry(const u8 *p, struct resource_entry *entry);
 422 extern u8 *put_resource_entry(u8 *p, const struct resource_entry *entry);
 423
 424 extern int read_uncompressed_resource(FILE *fp, u64 offset, u64 size, u8 buf[]);
 425
 426 extern int read_wim_resource(const struct lookup_table_entry *lte, u8 buf[],
 427                              size_t size, u64 offset, bool raw);
 428
 429 extern int read_full_wim_resource(const struct lookup_table_entry *lte, u8 buf[]);
 430
 431 extern int extract_wim_resource_to_fd(const struct lookup_table_entry *lte,
 432                                       int fd, u64 size);
 433
 434
 435 extern int extract_full_wim_resource_to_fd(const struct lookup_table_entry *lte,
 436                                            int fd);
 437
 438 extern int read_metadata_resource(WIMStruct *w,
 439                                   struct image_metadata *image_metadata);
 440
 441
 442 extern int write_dentry_resources(struct dentry *dentry, void *wim_p);
 443 extern int copy_resource(struct lookup_table_entry *lte, void *w);
 444 extern int write_metadata_resource(WIMStruct *w);
 445
 446
 447 /* security.c */
 448 int read_security_data(const u8 metadata_resource[],
 449                 u64 metadata_resource_len, struct wim_security_data **sd_p);
 450
 451 void print_security_data(const struct wim_security_data *sd);
 452 u8 *write_security_data(const struct wim_security_data *sd, u8 *p);
 453 void free_security_data(struct wim_security_data *sd);
 454
 455 /* symlink.c */
 456 ssize_t inode_readlink(const struct inode *inode, char *buf, size_t buf_len,
 457                         const WIMStruct *w);
 458 extern void *make_symlink_reparse_data_buf(const char *symlink_target,
 459                                            size_t *len_ret);
 460 extern int inode_set_symlink(struct inode *inode,
 461                              const char *target,
 462                              struct lookup_table *lookup_table,
 463                              struct lookup_table_entry **lte_ret);
 464
 465 /* wim.c */
 466 extern WIMStruct *new_wim_struct();
 467 extern int wimlib_select_image(WIMStruct *w, int image);
 468 extern int wim_hdr_flags_compression_type(int wim_hdr_flags);
 469 extern int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
 470
 471 /* write.c */
 472 extern int finish_write(WIMStruct *w, int image, int flags,
 473                         int write_lookup_table);
 474
 475 extern int begin_write(WIMStruct *w, const char *path, int flags);
 476
 477
 478 #include "wimlib.h"
 479
 480 #endif /* _WIMLIB_INTERNAL_H */
 481