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