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