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 Lesser General Public License as published by the Free
  15  * Software Foundation; either version 2.1 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 Lesser General Public License for more
  21  * details.
  22  *
  23  * You should have received a copy of the GNU Lesser 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
  34 #define WIM_HASH_SIZE  20
  35 #define WIM_MAGIC_LEN  8
  36 #define WIM_GID_LEN    16
  37 #define WIM_UNUSED_LEN 60
  38
  39
  40 /* Length of the WIM header on disk. */
  41 #define WIM_HEADER_DISK_SIZE (148 + WIM_UNUSED_LEN)
  42
  43 /* Compressed resources in the WIM are divided into separated compressed chunks
  44  * of this size. */
  45 #define WIM_CHUNK_SIZE 32768
  46
  47 /* Version of the WIM file.  I don't know if there has ever been a different
  48  * version or not. */
  49 #define WIM_VERSION 0x10d00
  50
  51 enum wim_integrity_status {
  52         WIM_INTEGRITY_OK,
  53         WIM_INTEGRITY_NOT_OK,
  54         WIM_INTEGRITY_NONEXISTENT,
  55 };
  56
  57 /* Metadata for a resource in a WIM file. */
  58 struct resource_entry {
  59         /* Size, in bytes, of the resource in the WIM file. */
  60         u64 size  : 56;
  61
  62         /* Bitwise or of one or more of the WIM_RESHDR_FLAG_* flags. */
  63         u64 flags : 8;
  64
  65         /* Offset, in bytes, of the resource in the WIM file. */
  66         u64 offset;
  67
  68         /* Uncompressed size of the resource in the WIM file.  Is the same as
  69          * @size if the resource is uncompressed. */
  70         u64 original_size;
  71 };
  72
  73 /* Flags for the `flags' field of the struct resource_entry structure. */
  74
  75 /* ??? */
  76 #define WIM_RESHDR_FLAG_FREE            0x01
  77
  78 /* Indicates that a file resource is a metadata resource. */
  79 #define WIM_RESHDR_FLAG_METADATA        0x02
  80
  81 /* Indicates that a file resource is compressed. */
  82 #define WIM_RESHDR_FLAG_COMPRESSED      0x04
  83
  84 /* ??? */
  85 #define WIM_RESHDR_FLAG_SPANNED         0x08
  86
  87
  88 /* Header at the very beginning of the WIM file. */
  89 struct wim_header {
  90         /* Identifies the file as WIM file. Must be exactly
  91          * {'M', 'S', 'W', 'I', 'M', 0, 0, 0}  */
  92         //u8  magic[WIM_MAGIC_LEN];
  93
  94         /* size of WIM header in bytes. */
  95         //u32 hdr_size;
  96
  97         /* Version of the WIM file.  M$ provides no documentation about exactly
  98          * what this field affects about the file format, other than the fact
  99          * that more recent versions have a higher value. */
 100         //u32 version;
 101
 102         /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
 103         u32 flags;
 104
 105         /* The size of the pieces that the uncompressed files were split up into
 106          * when they were compressed.  This should be the same as
 107          * WIM_CHUNK_SIZE.  M$ incorrectly documents this as "the size of the
 108          * compressed .wim file in bytes".*/
 109         //u32 chunk_size;
 110
 111         /* A unique identifier for the WIM file. */
 112         u8  guid[WIM_GID_LEN];
 113
 114         /* Part number of the WIM file in a spanned set. */
 115         u16 part_number;
 116
 117         /* Total number of parts in a spanned set. */
 118         u16 total_parts;
 119
 120         /* Number of images in the WIM file. */
 121         u32 image_count;
 122
 123         /* Location, size, and flags of the lookup table of the WIM. */
 124         struct resource_entry lookup_table_res_entry;
 125
 126         /* Location, size, and flags for the XML data of the WIM. */
 127         struct resource_entry xml_res_entry;
 128
 129         /* Location, size, and flags for the boot metadata.  This means the
 130          * metadata resource for the image specified by boot_idx below.  Should
 131          * be zeroed out if boot_idx is 0. */
 132         struct resource_entry boot_metadata_res_entry;
 133
 134         /* The index of the bootable image in the WIM file. If 0, there are no
 135          * bootable images available. */
 136         u32 boot_idx;
 137
 138         /* The location of the optional integrity table used to verify the
 139          * integrity WIM.  Zeroed out if there is no integrity table.*/
 140         struct resource_entry integrity;
 141
 142         /* Reserved for future disuse */
 143         //u8 unused[WIM_UNUSED_LEN];
 144 };
 145
 146 /* Flags for the `flags' field of the struct wim_header. */
 147
 148
 149 /* Reserved for future use by M$ */
 150 #define WIM_HDR_FLAG_RESERVED           0x00000001
 151
 152 /* Files and metadata in the WIM are compressed. */
 153 #define WIM_HDR_FLAG_COMPRESSION        0x00000002
 154
 155 /* WIM is read-only. */
 156 #define WIM_HDR_FLAG_READONLY           0x00000004
 157
 158 /* Resource data specified by images in this WIM may be contained in a different
 159  * WIM */
 160 #define WIM_HDR_FLAG_SPANNED            0x00000008
 161
 162 /* The WIM contains resources only; no filesystem metadata. */
 163 #define WIM_HDR_FLAG_RESOURCE_ONLY      0x00000010
 164
 165 /* The WIM contains metadata only. */
 166 #define WIM_HDR_FLAG_METADATA_ONLY      0x00000020
 167
 168 /* Lock field to prevent multiple writers from writing the WIM concurrently. */
 169 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS  0x00000040
 170
 171 /* Reparse point fixup ??? */
 172 #define WIM_HDR_FLAG_RP_FIX             0x00000080
 173
 174 /* Unknown compression type */
 175 #define WIM_HDR_FLAG_COMPRESS_RESERVED  0x00010000
 176
 177 /* Resources within the WIM are compressed using "XPRESS" compression, which is
 178  * a LZ77-based compression algorithm. */
 179 #define WIM_HDR_FLAG_COMPRESS_XPRESS    0x00020000
 180
 181 /* Resources within the WIM are compressed using "LZX" compression.  This is also
 182  * a LZ77-based algorithm. */
 183 #define WIM_HDR_FLAG_COMPRESS_LZX       0x00040000
 184
 185
 186 /* Structure for security data.  Each image in the WIM file has its own security
 187  * data. */
 188 struct wim_security_data {
 189         /* The total length of the security data, in bytes.  A typical size is
 190          * 2048 bytes.  If there is no security data, though (as in the WIMs
 191          * that wimlib writes, currently), it will be 8 bytes. */
 192         u32 total_length;
 193
 194         /* The number of security descriptors in the array @descriptors, below. */
 195         u32 num_entries;
 196
 197         /* Array of sizes of the descriptors in the array @descriptors. */
 198         u64 *sizes;
 199
 200         /* Array of descriptors. */
 201         u8 **descriptors;
 202
 203         /* keep track of how many WIMs reference this security data (used when
 204          * exporting images between WIMs) */
 205         u32 refcnt;
 206 } WIMSecurityData;
 207
 208 /* Metadata resource for an image. */
 209 struct image_metadata {
 210         /* Pointer to the root dentry for the image. */
 211         struct dentry    *root_dentry;
 212
 213         /* Pointer to the security data for the image. */
 214         struct wim_security_data *security_data;
 215
 216         /* A pointer to the lookup table entry for this image's metadata
 217          * resource. */
 218         struct lookup_table_entry *metadata_lte;
 219
 220         /* True if the filesystem of the image has been modified.  If this is
 221          * the case, the memory for the filesystem is not freed when switching
 222          * to a different WIM image. */
 223         bool modified;
 224
 225 };
 226
 227 /* The opaque structure exposed to the wimlib API. */
 228 typedef struct WIMStruct {
 229
 230         /* A pointer to the file indicated by @filename, opened for reading. */
 231         FILE                *fp;
 232
 233         /* FILE pointer for the WIM file that is being written. */
 234         FILE  *out_fp;
 235
 236         /* The name of the WIM file that has been opened. */
 237         char                *filename;
 238
 239         /* The lookup table for the WIM file. */
 240         struct lookup_table *lookup_table;
 241
 242         /* Pointer to the XML data read from the WIM file. */
 243         u8                  *xml_data;
 244
 245         /* Information retrieved from the XML data, arranged
 246          * in an orderly manner. */
 247         struct wim_info      *wim_info;
 248
 249         /* Array of the image metadata of length image_count.  Each image in the
 250          * WIM has a image metadata associated with it. */
 251         struct image_metadata     *image_metadata;
 252
 253         /* Name of the output directory for extraction. */
 254         char  *output_dir;
 255
 256         /* The header of the WIM file. */
 257         struct wim_header    hdr;
 258
 259         /* Temporary flags to use when extracting a WIM image or adding a WIM
 260          * image. */
 261         union {
 262                 int extract_flags;
 263                 int add_flags;
 264         };
 265
 266         /* The currently selected image, indexed starting at 1.  If not 0,
 267          * subtract 1 from this to get the index of the current image in the
 268          * image_metadata array. */
 269         int current_image;
 270
 271         union {
 272                 /* Set to true when extracting multiple images */
 273                 bool is_multi_image_extraction;
 274
 275                 bool write_metadata;
 276         };
 277 } WIMStruct;
 278
 279
 280 /* Inline utility functions for WIMStructs. */
 281
 282 static inline struct dentry *wim_root_dentry(WIMStruct *w)
 283 {
 284         return w->image_metadata[w->current_image - 1].root_dentry;
 285 }
 286
 287 static inline struct dentry **wim_root_dentry_p(WIMStruct *w)
 288 {
 289         return &w->image_metadata[w->current_image - 1].root_dentry;
 290 }
 291
 292 static inline struct wim_security_data *wim_security_data(WIMStruct *w)
 293 {
 294         return w->image_metadata[w->current_image - 1].security_data;
 295 }
 296
 297 static inline struct lookup_table_entry*
 298 wim_metadata_lookup_table_entry(WIMStruct *w)
 299 {
 300         return w->image_metadata[w->current_image - 1].metadata_lte;
 301 }
 302
 303 /* Nonzero if a struct resource_entry indicates a compressed resource. */
 304 static inline int resource_is_compressed(const struct resource_entry *entry)
 305 {
 306         return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
 307 }
 308
 309 static inline struct image_metadata *wim_get_current_image_metadata(WIMStruct *w)
 310 {
 311         return &w->image_metadata[w->current_image - 1];
 312 }
 313
 314 /* Prints a hash code field. */
 315 static inline void print_hash(const u8 hash[])
 316 {
 317         print_byte_field(hash, WIM_HASH_SIZE);
 318 }
 319
 320
 321 /* header.c */
 322 extern int read_header(FILE *fp, struct wim_header *hdr, int split_ok);
 323 extern int write_header(const struct wim_header *hdr, FILE *out);
 324 extern int init_header(struct wim_header *hdr, int ctype);
 325
 326 /* integrity.c */
 327 extern int write_integrity_table(FILE *out, u64 end_header_offset,
 328                                  u64 end_lookup_table_offset,
 329                                  int show_progress);
 330 extern int check_wim_integrity(WIMStruct *w, int show_progress, int *status);
 331
 332
 333 /* resource.c */
 334 extern const u8 *get_resource_entry(const u8 *p, struct resource_entry *entry);
 335 extern u8 *put_resource_entry(u8 *p, const struct resource_entry *entry);
 336
 337 extern int read_resource(FILE *fp, u64 resource_size,
 338                          u64 resource_original_size,
 339                          u64 resource_offset, int resource_ctype, u64 len,
 340                          u64 offset, void *contents_ret);
 341
 342 extern int read_uncompressed_resource(FILE *fp, u64 offset, u64 len,
 343                                         u8 contents_ret[]);
 344
 345
 346 extern int extract_resource_to_fd(WIMStruct *w,
 347                                   const struct resource_entry *entry,
 348                                   int fd,
 349                                   u64 size);
 350
 351 extern int extract_full_resource_to_fd(WIMStruct *w,
 352                                        const struct resource_entry *entry,
 353                                        int fd);
 354
 355 extern int read_metadata_resource(FILE *fp, int wim_ctype,
 356                                   struct image_metadata *image_metadata);
 357
 358 extern int resource_compression_type(int wim_ctype, int reshdr_flags);
 359
 360 static inline int read_full_resource(FILE *fp, u64 resource_size,
 361                                      u64 resource_original_size,
 362                                      u64 resource_offset,
 363                                      int resource_ctype, void *contents_ret)
 364 {
 365         return read_resource(fp, resource_size, resource_original_size,
 366                                 resource_offset, resource_ctype,
 367                                 resource_original_size, 0, contents_ret);
 368 }
 369
 370 extern int write_file_resource(struct dentry *dentry, void *wim_p);
 371 extern int copy_resource(struct lookup_table_entry *lte, void *w);
 372 extern int copy_between_files(FILE *in, off_t in_offset, FILE *out, size_t len);
 373 extern int write_resource_from_memory(const u8 resource[], int out_ctype,
 374                                       u64 resource_original_size, FILE *out,
 375                                       u64 *resource_size_ret);
 376 extern int write_metadata_resource(WIMStruct *w);
 377
 378 /* security.c */
 379 int read_security_data(const u8 metadata_resource[],
 380                 u64 metadata_resource_len, struct wim_security_data **sd_p);
 381
 382 void print_security_data(const struct wim_security_data *sd);
 383 u8 *write_security_data(const struct wim_security_data *sd, u8 *p);
 384 void free_security_data(struct wim_security_data *sd);
 385
 386 /* wim.c */
 387 extern WIMStruct *new_wim_struct();
 388 extern int wimlib_select_image(WIMStruct *w, int image);
 389 extern int wim_hdr_flags_compression_type(int wim_hdr_flags);
 390 extern int wim_resource_compression_type(const WIMStruct *w,
 391                                          const struct resource_entry *entry);
 392 extern int for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
 393
 394 /* write.c */
 395 extern int finish_write(WIMStruct *w, int image, int flags,
 396                         int write_lookup_table);
 397
 398 extern int begin_write(WIMStruct *w, const char *path, int flags);
 399
 400
 401 #include "wimlib.h"
 402
 403 #endif /* _WIMLIB_INTERNAL_H */
 404