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