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