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) 2012, 2013 Eric Biggers
   9  *
  10  * This file is part of wimlib, a library for working with WIM files.
  11  *
  12  * wimlib is free software; you can redistribute it and/or modify it under the
  13  * terms of the GNU General Public License as published by the Free
  14  * Software Foundation; either version 3 of the License, or (at your option)
  15  * any later version.
  16  *
  17  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  18  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  19  * A PARTICULAR PURPOSE. See the GNU General Public License for more
  20  * details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  24  */
  25
  26 #ifndef _WIMLIB_INTERNAL_H
  27 #define _WIMLIB_INTERNAL_H
  28
  29 #include "config.h"
  30 #include "util.h"
  31 #include "list.h"
  32 #include "wimlib.h"
  33
  34 #ifdef WITH_FUSE
  35 #include <pthread.h>
  36 #endif
  37
  38 #define WIMLIB_MAKEVERSION(major, minor, patch) \
  39         ((major << 20) | (minor << 10) | patch)
  40
  41
  42 #define WIMLIB_VERSION_CODE \
  43                 WIMLIB_MAKEVERSION(WIMLIB_MAJOR_VERSION,\
  44                                    WIMLIB_MINOR_VERSION,\
  45                                    WIMLIB_PATCH_VERSION)
  46
  47 #define WIMLIB_GET_PATCH_VERSION(version) \
  48         ((version >> 0) & ((1 << 10) - 1))
  49 #define WIMLIB_GET_MINOR_VERSION(version) \
  50         ((version >> 10) & ((1 << 10) - 1))
  51 #define WIMLIB_GET_MAJOR_VERSION(version) \
  52         ((version >> 20) & ((1 << 10) - 1))
  53
  54
  55 struct stat;
  56 struct wim_dentry;
  57 struct wim_inode;
  58 struct sd_set;
  59
  60 #define WIM_MAGIC_LEN  8
  61 #define WIM_GID_LEN    16
  62 #define WIM_UNUSED_LEN 60
  63
  64 /* Length of the WIM header on disk. */
  65 #define WIM_HEADER_DISK_SIZE (148 + WIM_UNUSED_LEN)
  66
  67 /* Compressed resources in the WIM are divided into separated compressed chunks
  68  * of this size. */
  69 #define WIM_CHUNK_SIZE 32768
  70
  71 /* Version of the WIM file.  There is an older version, but we don't support it
  72  * yet.  The differences between the versions are undocumented. */
  73 #define WIM_VERSION 0x10d00
  74
  75 /* Metadata for a resource in a WIM file. */
  76 struct resource_entry {
  77         /* Size, in bytes, of the resource in the WIM file. */
  78         u64 size  : 56;
  79
  80         /* Bitwise or of one or more of the WIM_RESHDR_FLAG_* flags. */
  81         u64 flags : 8;
  82
  83         /* Offset, in bytes, of the resource in the WIM file. */
  84         u64 offset;
  85
  86         /* Uncompressed size of the resource in the WIM file.  Is the same as
  87          * @size if the resource is uncompressed. */
  88         u64 original_size;
  89 };
  90
  91 /* Flags for the `flags' field of the struct resource_entry structure. */
  92
  93 /* I haven't seen this flag used in any of the WIMs I have examined.  I assume
  94  * it means that there are no references to the stream, so the space is free.
  95  * However, even after deleting files from a WIM mounted with `imagex.exe
  96  * /mountrw', I could not see this flag being used.  Either way, we don't
  97  * actually use this flag for anything. */
  98 #define WIM_RESHDR_FLAG_FREE            0x01
  99
 100 /* Indicates that the stream is a metadata resource for a WIM image. */
 101 #define WIM_RESHDR_FLAG_METADATA        0x02
 102
 103 /* Indicates that the stream is compressed. */
 104 #define WIM_RESHDR_FLAG_COMPRESSED      0x04
 105
 106 /* I haven't seen this flag used in any of the WIMs I have examined.  Perhaps it
 107  * means that a stream could possibly be split among multiple split WIM parts.
 108  * However, `imagex.exe /split' does not seem to create any WIMs like this.
 109  * Either way, we don't actually use this flag for anything.  */
 110 #define WIM_RESHDR_FLAG_SPANNED         0x08
 111
 112 /* Header at the very beginning of the WIM file. */
 113 struct wim_header {
 114         /* Identifies the file as WIM file. Must be exactly
 115          * {'M', 'S', 'W', 'I', 'M', 0, 0, 0}  */
 116         //u8  magic[WIM_MAGIC_LEN];
 117
 118         /* size of WIM header in bytes. */
 119         //u32 hdr_size;
 120
 121         /* Version of the WIM file.  Microsoft provides no documentation about
 122          * exactly what this field affects about the file format, other than the
 123          * fact that more recent versions have a higher value. */
 124         //u32 version;
 125
 126         /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
 127         u32 flags;
 128
 129         /* The size of the pieces that the uncompressed files were split up into
 130          * when they were compressed.  This should be the same as
 131          * WIM_CHUNK_SIZE.  Microsoft incorrectly documents this as "the size of
 132          * the compressed .wim file in bytes".*/
 133         //u32 chunk_size;
 134
 135         /* A unique identifier for the WIM file. */
 136         u8 guid[WIM_GID_LEN];
 137
 138         /* Part number of the WIM file in a spanned set. */
 139         u16 part_number;
 140
 141         /* Total number of parts in a spanned set. */
 142         u16 total_parts;
 143
 144         /* Number of images in the WIM file. */
 145         u32 image_count;
 146
 147         /* Location, size, and flags of the lookup table of the WIM. */
 148         struct resource_entry lookup_table_res_entry;
 149
 150         /* Location, size, and flags for the XML data of the WIM. */
 151         struct resource_entry xml_res_entry;
 152
 153         /* Location, size, and flags for the boot metadata.  This means the
 154          * metadata resource for the image specified by boot_idx below.  Should
 155          * be zeroed out if boot_idx is 0. */
 156         struct resource_entry boot_metadata_res_entry;
 157
 158         /* The index of the bootable image in the WIM file. If 0, there are no
 159          * bootable images available. */
 160         u32 boot_idx;
 161
 162         /* The location of the optional integrity table used to verify the
 163          * integrity WIM.  Zeroed out if there is no integrity table.*/
 164         struct resource_entry integrity;
 165
 166         /* Reserved for future disuse */
 167         //u8 unused[WIM_UNUSED_LEN];
 168 };
 169
 170 /* Flags for the `flags' field of the struct wim_header: */
 171
 172 /* Reserved for future use */
 173 #define WIM_HDR_FLAG_RESERVED           0x00000001
 174
 175 /* Files and metadata in the WIM are compressed. */
 176 #define WIM_HDR_FLAG_COMPRESSION        0x00000002
 177
 178 /* WIM is read-only (wimlib ignores this because it's pretty much pointless) */
 179 #define WIM_HDR_FLAG_READONLY           0x00000004
 180
 181 /* Resource data specified by images in this WIM may be contained in a different
 182  * WIM.  Or in other words, this WIM is part of a split WIM.  */
 183 #define WIM_HDR_FLAG_SPANNED            0x00000008
 184
 185 /* The WIM contains resources only; no filesystem metadata.  wimlib ignores this
 186  * flag, as it looks for resources in all the WIMs anyway. */
 187 #define WIM_HDR_FLAG_RESOURCE_ONLY      0x00000010
 188
 189 /* The WIM contains metadata only.  wimlib ignores this flag.  Note that all the
 190  * metadata resources for a split WIM should be in the first part. */
 191 #define WIM_HDR_FLAG_METADATA_ONLY      0x00000020
 192
 193 /* Lock field to prevent multiple writers from writing the WIM concurrently.
 194  * wimlib ignores this flag as it uses flock() to acquire a real lock on the
 195  * file (if supported by the underlying filesystem). */
 196 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS  0x00000040
 197
 198 /* Reparse point fixup ???
 199  * This has something to do with absolute targets of reparse points / symbolic
 200  * links but I don't know what.  wimlib ignores this flag.  */
 201 #define WIM_HDR_FLAG_RP_FIX             0x00000080
 202
 203 /* Unused, reserved flag for another compression type */
 204 #define WIM_HDR_FLAG_COMPRESS_RESERVED  0x00010000
 205
 206 /* Resources within the WIM are compressed using "XPRESS" compression, which is
 207  * a LZ77-based compression algorithm. */
 208 #define WIM_HDR_FLAG_COMPRESS_XPRESS    0x00020000
 209
 210 /* Resources within the WIM are compressed using "LZX" compression.  This is also
 211  * a LZ77-based algorithm. */
 212 #define WIM_HDR_FLAG_COMPRESS_LZX       0x00040000
 213
 214 #ifdef WITH_NTFS_3G
 215 struct _ntfs_volume;
 216 #endif
 217
 218 /* Table of security descriptors for a WIM image. */
 219 struct wim_security_data {
 220         /* The total length of the security data, in bytes.  If there are no
 221          * security descriptors, this field, when read from the on-disk metadata
 222          * resource, may be either 8 (which is correct) or 0 (which is
 223          * interpreted as 0). */
 224         u32 total_length;
 225
 226         /* The number of security descriptors in the array @descriptors, below.
 227          * It is really an unsigned int on-disk, but it must fit into an int
 228          * because the security ID's are signed.  (Not like you would ever have
 229          * more than a few hundred security descriptors anyway.) */
 230         int32_t num_entries;
 231
 232         /* Array of sizes of the descriptors in the array @descriptors. */
 233         u64 *sizes;
 234
 235         /* Array of descriptors. */
 236         u8 **descriptors;
 237
 238         /* Keep track of how many WIMs reference this security data (used when
 239          * exporting images between WIMs) */
 240         u32 refcnt;
 241 };
 242
 243 /* Metadata for a WIM image */
 244 struct wim_image_metadata {
 245
 246         /* Pointer to the root dentry of the image. */
 247         struct wim_dentry    *root_dentry;
 248
 249         /* Pointer to the security data of the image. */
 250         struct wim_security_data *security_data;
 251
 252         /* Pointer to the lookup table entry for this image's metadata resource
 253          */
 254         struct wim_lookup_table_entry *metadata_lte;
 255
 256         /* Linked list of inodes of this image */
 257         struct hlist_head inode_list;
 258
 259         /* 1 iff the dentry tree has been modified.  If this is the case, the
 260          * memory for the dentry tree should not be freed when switching to a
 261          * different WIM image. */
 262         u8 modified : 1;
 263
 264         /* 1 iff this image has been mounted read-write */
 265         u8 has_been_mounted_rw : 1;
 266 };
 267
 268 /* The opaque structure exposed to the wimlib API. */
 269 struct WIMStruct {
 270
 271         /* A pointer to the file indicated by @filename, opened for reading. */
 272         FILE *fp;
 273
 274 #ifdef WITH_FUSE
 275         /* Extra file pointers to be used by concurrent readers */
 276         FILE **fp_tab;
 277         size_t num_allocated_fps;
 278         pthread_mutex_t fp_tab_mutex;
 279 #endif
 280
 281         /* FILE pointer for the WIM file (if any) currently being written. */
 282         FILE *out_fp;
 283
 284         /* The name of the WIM file (if any) that has been opened. */
 285         tchar *filename;
 286
 287         /* The lookup table for the WIM file. */
 288         struct wim_lookup_table *lookup_table;
 289
 290         /* Pointer to the XML data read from the WIM file (UTF16LE-encoded). */
 291         utf16lechar *xml_data;
 292
 293         /* Information retrieved from the XML data, arranged in an orderly
 294          * manner. */
 295         struct wim_info *wim_info;
 296
 297         /* Array of the image metadata, one for each image in the WIM. */
 298         struct wim_image_metadata *image_metadata;
 299
 300         /* The header of the WIM file. */
 301         struct wim_header hdr;
 302
 303         /* Temporary fields */
 304         union {
 305                 bool write_metadata;
 306                 void *private;
 307         };
 308 #ifdef WITH_NTFS_3G
 309         struct _ntfs_volume *ntfs_vol;
 310 #endif
 311
 312         /* The currently selected image, indexed starting at 1.  If not 0,
 313          * subtract 1 from this to get the index of the current image in the
 314          * image_metadata array. */
 315         int current_image;
 316
 317         u8 deletion_occurred : 1;
 318         u8 all_images_verified : 1;
 319         u8 wim_locked : 1;
 320 };
 321
 322 /* Inline utility functions for WIMStructs. */
 323
 324 static inline struct wim_dentry *
 325 wim_root_dentry(WIMStruct *w)
 326 {
 327         return w->image_metadata[w->current_image - 1].root_dentry;
 328 }
 329
 330 static inline struct wim_security_data *
 331 wim_security_data(WIMStruct *w)
 332 {
 333         return w->image_metadata[w->current_image - 1].security_data;
 334 }
 335 static inline const struct wim_security_data *
 336 wim_const_security_data(const WIMStruct *w)
 337 {
 338         return w->image_metadata[w->current_image - 1].security_data;
 339 }
 340
 341 static inline struct wim_image_metadata *
 342 wim_get_current_image_metadata(WIMStruct *w)
 343 {
 344         return &w->image_metadata[w->current_image - 1];
 345 }
 346
 347 /* Nonzero if a struct resource_entry indicates a compressed resource. */
 348 static inline int
 349 resource_is_compressed(const struct resource_entry *entry)
 350 {
 351         return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
 352 }
 353
 354 /* add_image.c */
 355
 356 struct pattern_list {
 357         const tchar **pats;
 358         size_t num_pats;
 359         size_t num_allocated_pats;
 360 };
 361
 362 struct capture_config {
 363         struct pattern_list exclusion_list;
 364         struct pattern_list exclusion_exception;
 365         struct pattern_list compression_exclusion_list;
 366         struct pattern_list alignment_list;
 367         tchar *config_str;
 368         tchar *prefix;
 369         size_t prefix_num_tchars;
 370 };
 371 extern bool
 372 exclude_path(const tchar *path, const struct capture_config *config,
 373              bool exclude_prefix);
 374
 375 extern int
 376 add_new_dentry_tree(WIMStruct *dest_wim, struct wim_dentry *root,
 377                     struct wim_security_data *sd);
 378
 379
 380 /* extract_image.c */
 381
 382 /* Internal use only */
 383 #define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE         0x80000000
 384 #define WIMLIB_EXTRACT_FLAG_NO_STREAMS          0x40000000
 385 #define WIMLIB_EXTRACT_MASK_PUBLIC              0x3fffffff
 386
 387 /* hardlink.c */
 388
 389 extern u64
 390 assign_inode_numbers(struct hlist_head *inode_list);
 391
 392 extern int
 393 dentry_tree_fix_inodes(struct wim_dentry *root, struct hlist_head *inode_list);
 394
 395 /* header.c */
 396
 397 extern int
 398 read_header(FILE *fp, struct wim_header *hdr, int split_ok);
 399
 400 extern int
 401 write_header(const struct wim_header *hdr, FILE *out);
 402
 403 extern int
 404 init_header(struct wim_header *hdr, int ctype);
 405
 406 /* integrity.c */
 407
 408 #define WIM_INTEGRITY_OK 0
 409 #define WIM_INTEGRITY_NOT_OK -1
 410 #define WIM_INTEGRITY_NONEXISTENT -2
 411
 412 extern int
 413 write_integrity_table(FILE *out, struct resource_entry *integrity_res_entry,
 414                       off_t new_lookup_table_end,
 415                       off_t old_lookup_table_end,
 416                       wimlib_progress_func_t progress_func);
 417
 418 extern int
 419 check_wim_integrity(WIMStruct *w, wimlib_progress_func_t progress_func);
 420
 421 /* join.c */
 422
 423 extern int
 424 new_joined_lookup_table(WIMStruct *w, WIMStruct **additional_swms,
 425                         unsigned num_additional_swms,
 426                         struct wim_lookup_table **table_ret);
 427
 428 /* metadata_resource.c */
 429
 430 extern int
 431 read_metadata_resource(WIMStruct *w,
 432                                   struct wim_image_metadata *image_metadata);
 433
 434 extern int
 435 write_metadata_resource(WIMStruct *w);
 436
 437 /* ntfs-apply.c */
 438
 439 struct apply_args {
 440         WIMStruct *w;
 441         const tchar *target;
 442         int extract_flags;
 443         union wimlib_progress_info progress;
 444         wimlib_progress_func_t progress_func;
 445         int (*apply_dentry)(struct wim_dentry *, void *);
 446         union {
 447         #ifdef WITH_NTFS_3G
 448                 struct {
 449                         /* NTFS apply only */
 450                         struct _ntfs_volume *vol;
 451                 };
 452         #endif
 453                 struct {
 454                         /* Normal apply only (UNIX) */
 455                         unsigned long num_utime_warnings;
 456                 };
 457
 458                 struct {
 459                         /* Normal apply only (Win32) */
 460                         unsigned long num_set_sacl_priv_notheld;
 461                         unsigned long num_set_sd_access_denied;
 462                 };
 463         };
 464 };
 465
 466 extern int
 467 apply_dentry_ntfs(struct wim_dentry *dentry, void *arg);
 468
 469 extern int
 470 apply_dentry_timestamps_ntfs(struct wim_dentry *dentry, void *arg);
 471
 472 extern void
 473 libntfs3g_global_init();
 474
 475 /* ntfs-capture.c */
 476 extern int
 477 build_dentry_tree_ntfs(struct wim_dentry **root_p,
 478                        const tchar *device,
 479                        struct wim_lookup_table *lookup_table,
 480                        struct sd_set *sd_set,
 481                        const struct capture_config *config,
 482                        int add_image_flags,
 483                        wimlib_progress_func_t progress_func,
 484                        void *extra_arg);
 485
 486 /* resource.c */
 487
 488 #define WIMLIB_RESOURCE_FLAG_RAW                0x1
 489 #define WIMLIB_RESOURCE_FLAG_MULTITHREADED      0x2
 490 #define WIMLIB_RESOURCE_FLAG_RECOMPRESS         0x4
 491
 492 extern const u8 *
 493 get_resource_entry(const u8 *p, struct resource_entry *entry);
 494
 495 extern u8 *
 496 put_resource_entry(u8 *p, const struct resource_entry *entry);
 497
 498 extern int
 499 read_uncompressed_resource(FILE *fp, u64 offset, u64 size, void *buf);
 500
 501 extern int
 502 read_wim_resource(const struct wim_lookup_table_entry *lte, void *buf,
 503                   size_t size, u64 offset, int flags);
 504
 505 extern int
 506 read_full_wim_resource(const struct wim_lookup_table_entry *lte,
 507                        void *buf, int flags);
 508
 509 extern int
 510 write_wim_resource(struct wim_lookup_table_entry *lte, FILE *out_fp,
 511                    int out_ctype, struct resource_entry *out_res_entry,
 512                    int flags);
 513
 514
 515 typedef int (*extract_chunk_func_t)(const void *, size_t, u64, void *);
 516
 517 extern int
 518 extract_wim_chunk_to_fd(const void *buf, size_t len, u64 offset, void *arg);
 519
 520 extern int
 521 extract_wim_resource(const struct wim_lookup_table_entry *lte,
 522                      u64 size, extract_chunk_func_t extract_chunk,
 523                      void *extract_chunk_arg);
 524
 525 /*
 526  * Extracts the first @size bytes of the WIM resource specified by @lte to the
 527  * open file descriptor @fd.
 528  *
 529  * Returns 0 on success; nonzero on failure.
 530  */
 531 static inline int
 532 extract_wim_resource_to_fd(const struct wim_lookup_table_entry *lte,
 533                            int fd, u64 size)
 534 {
 535         return extract_wim_resource(lte, size,
 536                                     extract_wim_chunk_to_fd, &fd);
 537 }
 538
 539
 540 extern int
 541 write_dentry_resources(struct wim_dentry *dentry, void *wim_p);
 542
 543 extern int
 544 copy_resource(struct wim_lookup_table_entry *lte, void *w);
 545
 546
 547 /* security.c */
 548 extern int
 549 read_security_data(const u8 metadata_resource[],
 550                    u64 metadata_resource_len, struct wim_security_data **sd_p);
 551 extern void
 552 print_security_data(const struct wim_security_data *sd);
 553
 554 extern u8 *
 555 write_security_data(const struct wim_security_data *sd, u8 *p);
 556
 557 extern void
 558 free_security_data(struct wim_security_data *sd);
 559
 560 /* symlink.c */
 561
 562 #ifndef __WIN32__
 563 ssize_t
 564 inode_readlink(const struct wim_inode *inode, char *buf, size_t buf_len,
 565                const WIMStruct *w, int read_resource_flags);
 566
 567 extern int
 568 inode_set_symlink(struct wim_inode *inode, const char *target,
 569                   struct wim_lookup_table *lookup_table,
 570                   struct wim_lookup_table_entry **lte_ret);
 571 #endif
 572
 573 /* verify.c */
 574
 575 extern int
 576 verify_dentry(struct wim_dentry *dentry, void *wim);
 577
 578 extern int
 579 wim_run_full_verifications(WIMStruct *w);
 580
 581 extern int
 582 verify_swm_set(WIMStruct *w,
 583                WIMStruct **additional_swms, unsigned num_additional_swms);
 584
 585 /* wim.c */
 586
 587 extern int
 588 select_wim_image(WIMStruct *w, int image);
 589
 590 extern int
 591 for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
 592
 593 extern void
 594 destroy_image_metadata(struct wim_image_metadata *imd,
 595                        struct wim_lookup_table *lt);
 596
 597 /* write.c */
 598
 599 /* Internal use only */
 600 #define WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE       0x80000000
 601 #define WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE 0x40000000
 602 #define WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML  0x20000000
 603 #define WIMLIB_WRITE_MASK_PUBLIC                0x1fffffff
 604
 605 #define WIMLIB_ADD_IMAGE_FLAG_ROOT      0x80000000
 606 #define WIMLIB_ADD_IMAGE_FLAG_SOURCE    0x40000000
 607
 608
 609 extern int
 610 begin_write(WIMStruct *w, const tchar *path, int write_flags);
 611
 612 extern void
 613 close_wim_writable(WIMStruct *w);
 614
 615 extern int
 616 finish_write(WIMStruct *w, int image, int write_flags,
 617              wimlib_progress_func_t progress_func);
 618
 619 #if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
 620 extern int
 621 lock_wim(WIMStruct *w, FILE *fp);
 622 #else
 623 static inline int
 624 lock_wim(WIMStruct *w, FILE *fp)
 625 {
 626         return 0;
 627 }
 628 #endif
 629
 630 #endif /* _WIMLIB_INTERNAL_H */
 631