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