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) 2012, 2013 Eric Biggers
   9  *
  10  * This file is part of wimlib, a library for working with WIM files.
  11  *
  12  * wimlib is free software; you can redistribute it and/or modify it under the
  13  * terms of the GNU General Public License as published by the Free
  14  * Software Foundation; either version 3 of the License, or (at your option)
  15  * any later version.
  16  *
  17  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  18  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  19  * A PARTICULAR PURPOSE. See the GNU General Public License for more
  20  * details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  24  */
  25
  26 #ifndef _WIMLIB_INTERNAL_H
  27 #define _WIMLIB_INTERNAL_H
  28
  29 #include "config.h"
  30 #include "util.h"
  31 #include "list.h"
  32 #include "wimlib.h"
  33 #include "security.h"
  34
  35 #define WIMLIB_MAKEVERSION(major, minor, patch) \
  36         ((major << 20) | (minor << 10) | patch)
  37
  38
  39 #define WIMLIB_VERSION_CODE \
  40                 WIMLIB_MAKEVERSION(WIMLIB_MAJOR_VERSION,\
  41                                    WIMLIB_MINOR_VERSION,\
  42                                    WIMLIB_PATCH_VERSION)
  43
  44 #define WIMLIB_GET_PATCH_VERSION(version) \
  45         ((version >> 0) & ((1 << 10) - 1))
  46 #define WIMLIB_GET_MINOR_VERSION(version) \
  47         ((version >> 10) & ((1 << 10) - 1))
  48 #define WIMLIB_GET_MAJOR_VERSION(version) \
  49         ((version >> 20) & ((1 << 10) - 1))
  50
  51
  52 struct stat;
  53 struct wim_dentry;
  54 struct wim_inode;
  55 struct sd_set;
  56
  57 #define WIM_MAGIC_LEN  8
  58 #define WIM_GID_LEN    16
  59 #define WIM_UNUSED_LEN 60
  60
  61 /* Length of the WIM header on disk. */
  62 #define WIM_HEADER_DISK_SIZE (148 + WIM_UNUSED_LEN)
  63
  64 /* Compressed resources in the WIM are divided into separated compressed chunks
  65  * of this size. */
  66 #define WIM_CHUNK_SIZE 32768
  67
  68 /* Version of the WIM file.  There is an older version, but we don't support it
  69  * yet.  The differences between the versions are undocumented. */
  70 #define WIM_VERSION 0x10d00
  71
  72 #define REPARSE_POINT_MAX_SIZE (16 * 1024)
  73
  74 /* Metadata for a resource in a WIM file. */
  75 struct resource_entry {
  76         /* Size, in bytes, of the resource in the WIM file. */
  77         u64 size  : 56;
  78
  79         /* Bitwise or of one or more of the WIM_RESHDR_FLAG_* flags. */
  80         u64 flags : 8;
  81
  82         /* Offset, in bytes, of the resource in the WIM file. */
  83         u64 offset;
  84
  85         /* Uncompressed size of the resource in the WIM file.  Is the same as
  86          * @size if the resource is uncompressed. */
  87         u64 original_size;
  88 };
  89
  90 /* Flags for the `flags' field of the struct resource_entry structure. */
  91
  92 /* I haven't seen this flag used in any of the WIMs I have examined.  I assume
  93  * it means that there are no references to the stream, so the space is free.
  94  * However, even after deleting files from a WIM mounted with `imagex.exe
  95  * /mountrw', I could not see this flag being used.  Either way, we don't
  96  * actually use this flag for anything. */
  97 #define WIM_RESHDR_FLAG_FREE            0x01
  98
  99 /* Indicates that the stream is a metadata resource for a WIM image. */
 100 #define WIM_RESHDR_FLAG_METADATA        0x02
 101
 102 /* Indicates that the stream is compressed. */
 103 #define WIM_RESHDR_FLAG_COMPRESSED      0x04
 104
 105 /* I haven't seen this flag used in any of the WIMs I have examined.  Perhaps it
 106  * means that a stream could possibly be split among multiple split WIM parts.
 107  * However, `imagex.exe /split' does not seem to create any WIMs like this.
 108  * Either way, we don't actually use this flag for anything.  */
 109 #define WIM_RESHDR_FLAG_SPANNED         0x08
 110
 111 /* Header at the very beginning of the WIM file. */
 112 struct wim_header {
 113         /* Identifies the file as WIM file. Must be exactly
 114          * {'M', 'S', 'W', 'I', 'M', 0, 0, 0}  */
 115         //u8  magic[WIM_MAGIC_LEN];
 116
 117         /* size of WIM header in bytes. */
 118         //u32 hdr_size;
 119
 120         /* Version of the WIM file.  Microsoft provides no documentation about
 121          * exactly what this field affects about the file format, other than the
 122          * fact that more recent versions have a higher value. */
 123         //u32 version;
 124
 125         /* Bitwise OR of one or more of the WIM_HDR_FLAG_* defined below. */
 126         u32 flags;
 127
 128         /* The size of the pieces that the uncompressed files were split up into
 129          * when they were compressed.  This should be the same as
 130          * WIM_CHUNK_SIZE.  Microsoft incorrectly documents this as "the size of
 131          * the compressed .wim file in bytes".*/
 132         //u32 chunk_size;
 133
 134         /* A unique identifier for the WIM file. */
 135         u8 guid[WIM_GID_LEN];
 136
 137         /* Part number of the WIM file in a spanned set. */
 138         u16 part_number;
 139
 140         /* Total number of parts in a spanned set. */
 141         u16 total_parts;
 142
 143         /* Number of images in the WIM file. */
 144         u32 image_count;
 145
 146         /* Location, size, and flags of the lookup table of the WIM. */
 147         struct resource_entry lookup_table_res_entry;
 148
 149         /* Location, size, and flags for the XML data of the WIM. */
 150         struct resource_entry xml_res_entry;
 151
 152         /* Location, size, and flags for the boot metadata.  This means the
 153          * metadata resource for the image specified by boot_idx below.  Should
 154          * be zeroed out if boot_idx is 0. */
 155         struct resource_entry boot_metadata_res_entry;
 156
 157         /* The index of the bootable image in the WIM file. If 0, there are no
 158          * bootable images available. */
 159         u32 boot_idx;
 160
 161         /* The location of the optional integrity table used to verify the
 162          * integrity WIM.  Zeroed out if there is no integrity table.*/
 163         struct resource_entry integrity;
 164
 165         /* Reserved for future disuse */
 166         //u8 unused[WIM_UNUSED_LEN];
 167 };
 168
 169 /* Flags for the `flags' field of the struct wim_header: */
 170
 171 /* Reserved for future use */
 172 #define WIM_HDR_FLAG_RESERVED           0x00000001
 173
 174 /* Files and metadata in the WIM are compressed. */
 175 #define WIM_HDR_FLAG_COMPRESSION        0x00000002
 176
 177 /* WIM is read-only (wimlib ignores this because it's pretty much pointless) */
 178 #define WIM_HDR_FLAG_READONLY           0x00000004
 179
 180 /* Resource data specified by images in this WIM may be contained in a different
 181  * WIM.  Or in other words, this WIM is part of a split WIM.  */
 182 #define WIM_HDR_FLAG_SPANNED            0x00000008
 183
 184 /* The WIM contains resources only; no filesystem metadata.  wimlib ignores this
 185  * flag, as it looks for resources in all the WIMs anyway. */
 186 #define WIM_HDR_FLAG_RESOURCE_ONLY      0x00000010
 187
 188 /* The WIM contains metadata only.  wimlib ignores this flag.  Note that all the
 189  * metadata resources for a split WIM should be in the first part. */
 190 #define WIM_HDR_FLAG_METADATA_ONLY      0x00000020
 191
 192 /* Lock field to prevent multiple writers from writing the WIM concurrently.
 193  * wimlib ignores this flag as it uses flock() to acquire a real lock on the
 194  * file (if supported by the underlying filesystem). */
 195 #define WIM_HDR_FLAG_WRITE_IN_PROGRESS  0x00000040
 196
 197 /* Reparse point fixup flag.  See docs for --rpfix and --norpfix in imagex, or
 198  * WIMLIB_ADD_FLAG_{RPFIX,NORPFIX} in wimlib.h.  Note that
 199  * WIM_HDR_FLAG_RP_FIX is a header flag and just sets the default behavior for
 200  * the WIM; it can still be overridder on a per-image basis.  But there is no
 201  * flag to set the default behavior for a specific image. */
 202 #define WIM_HDR_FLAG_RP_FIX             0x00000080
 203
 204 /* Unused, reserved flag for another compression type */
 205 #define WIM_HDR_FLAG_COMPRESS_RESERVED  0x00010000
 206
 207 /* Resources within the WIM are compressed using "XPRESS" compression, which is
 208  * a LZ77-based compression algorithm. */
 209 #define WIM_HDR_FLAG_COMPRESS_XPRESS    0x00020000
 210
 211 /* Resources within the WIM are compressed using "LZX" compression.  This is also
 212  * a LZ77-based algorithm. */
 213 #define WIM_HDR_FLAG_COMPRESS_LZX       0x00040000
 214
 215 #ifdef WITH_NTFS_3G
 216 struct _ntfs_volume;
 217 #endif
 218
 219 /* Table of security descriptors for a WIM image. */
 220 struct wim_security_data {
 221         /* The total length of the security data, in bytes.  If there are no
 222          * security descriptors, this field, when read from the on-disk metadata
 223          * resource, may be either 8 (which is correct) or 0 (which is
 224          * interpreted as 0). */
 225         u32 total_length;
 226
 227         /* The number of security descriptors in the array @descriptors, below.
 228          * It is really an unsigned int on-disk, but it must fit into an int
 229          * because the security ID's are signed.  (Not like you would ever have
 230          * more than a few hundred security descriptors anyway.) */
 231         int32_t num_entries;
 232
 233         /* Array of sizes of the descriptors in the array @descriptors. */
 234         u64 *sizes;
 235
 236         /* Array of descriptors. */
 237         u8 **descriptors;
 238 };
 239
 240 /* Metadata for a WIM image */
 241 struct wim_image_metadata {
 242
 243         /* Number of WIMStruct's that are sharing this image metadata (from
 244          * calls to wimlib_export_image().) */
 245         unsigned long refcnt;
 246
 247         /* Pointer to the root dentry of the image. */
 248         struct wim_dentry *root_dentry;
 249
 250         /* Pointer to the security data of the image. */
 251         struct wim_security_data *security_data;
 252
 253         /* Pointer to the lookup table entry for this image's metadata resource
 254          */
 255         struct wim_lookup_table_entry *metadata_lte;
 256
 257         /* Linked list of 'struct wim_inode's for this image. */
 258         struct list_head inode_list;
 259
 260         /* Linked list of 'struct wim_lookup_table_entry's for this image that
 261          * are referred to in the dentry tree, but have not had a SHA1 message
 262          * digest calculated yet and therefore have not been inserted into the
 263          * WIM's lookup table.  This list is added to during wimlib_add_image()
 264          * and wimlib_mount_image() (read-write only). */
 265         struct list_head unhashed_streams;
 266
 267         /* 1 iff the dentry tree has been modified.  If this is the case, the
 268          * memory for the dentry tree should not be freed when switching to a
 269          * different WIM image. */
 270         u8 modified : 1;
 271
 272 #ifdef WITH_NTFS_3G
 273         struct _ntfs_volume *ntfs_vol;
 274 #endif
 275 };
 276
 277 /* The opaque structure exposed to the wimlib API. */
 278 struct WIMStruct {
 279
 280         /* File descriptor for the WIM file, opened for reading, or -1 if it has
 281          * not been opened or there is no associated file backing it yet. */
 282         int in_fd;
 283
 284         /* File descriptor, opened either for writing only or for
 285          * reading+writing, for the WIM file (if any) currently being written.
 286          * */
 287         int out_fd;
 288
 289         /* The name of the WIM file (if any) that has been opened. */
 290         tchar *filename;
 291
 292         /* The lookup table for the WIM file. */
 293         struct wim_lookup_table *lookup_table;
 294
 295         /* Information retrieved from the XML data, arranged in an orderly
 296          * manner. */
 297         struct wim_info *wim_info;
 298
 299         /* Array of the image metadata, one for each image in the WIM. */
 300         struct wim_image_metadata **image_metadata;
 301
 302         /* The header of the WIM file. */
 303         struct wim_header hdr;
 304
 305         /* Temporary field */
 306         void *private;
 307
 308         /* The currently selected image, indexed starting at 1.  If not 0,
 309          * subtract 1 from this to get the index of the current image in the
 310          * image_metadata array. */
 311         int current_image;
 312
 313         /* Have any images been deleted? */
 314         u8 deletion_occurred : 1;
 315
 316         u8 all_images_verified : 1;
 317         u8 wim_locked : 1;
 318 };
 319
 320 /* Inline utility functions for WIMStructs. */
 321
 322 static inline struct wim_image_metadata *
 323 wim_get_current_image_metadata(WIMStruct *w)
 324 {
 325         return w->image_metadata[w->current_image - 1];
 326 }
 327
 328 static inline const struct wim_image_metadata *
 329 wim_get_const_current_image_metadata(const WIMStruct *w)
 330 {
 331         return w->image_metadata[w->current_image - 1];
 332 }
 333
 334 static inline struct wim_dentry *
 335 wim_root_dentry(WIMStruct *w)
 336 {
 337         return wim_get_current_image_metadata(w)->root_dentry;
 338 }
 339
 340 static inline struct wim_security_data *
 341 wim_security_data(WIMStruct *w)
 342 {
 343         return wim_get_current_image_metadata(w)->security_data;
 344 }
 345
 346 static inline const struct wim_security_data *
 347 wim_const_security_data(const WIMStruct *w)
 348 {
 349         return wim_get_const_current_image_metadata(w)->security_data;
 350 }
 351
 352 /* Nonzero if a struct resource_entry indicates a compressed resource. */
 353 static inline int
 354 resource_is_compressed(const struct resource_entry *entry)
 355 {
 356         return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
 357 }
 358
 359 /* Iterate over each inode in a WIM image that has not yet been hashed */
 360 #define image_for_each_inode(inode, imd) \
 361         list_for_each_entry(inode, &imd->inode_list, i_list)
 362
 363 /* Iterate over each stream in a WIM image that has not yet been hashed */
 364 #define image_for_each_unhashed_stream(lte, imd) \
 365         list_for_each_entry(lte, &imd->unhashed_streams, unhashed_list)
 366
 367 /* Iterate over each stream in a WIM image that has not yet been hashed (safe
 368  * against stream removal) */
 369 #define image_for_each_unhashed_stream_safe(lte, tmp, imd) \
 370         list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list)
 371
 372 #if 1
 373 #  define copy_resource_entry(dst, src) memcpy(dst, src, sizeof(struct resource_entry))
 374 #  define zero_resource_entry(entry) memset(entry, 0, sizeof(struct resource_entry))
 375 #else
 376 static inline void
 377 copy_resource_entry(struct resource_entry *dst,
 378                     const struct resource_entry *src)
 379 {
 380         BUILD_BUG_ON(sizeof(struct resource_entry) != 24);
 381         ((u64*)dst)[0] = ((u64*)src)[0];
 382         ((u64*)dst)[1] = ((u64*)src)[1];
 383         ((u64*)dst)[2] = ((u64*)src)[2];
 384 }
 385
 386 static inline void
 387 zero_resource_entry(struct resource_entry *entry)
 388 {
 389         BUILD_BUG_ON(sizeof(struct resource_entry) != 24);
 390         ((u64*)entry)[0] = 0;
 391         ((u64*)entry)[1] = 0;
 392         ((u64*)entry)[2] = 0;
 393 }
 394 #endif
 395
 396 /* add_image.c */
 397
 398 /* Hash table to find inodes, given an inode number (in the case of reading
 399  * a WIM images), or both an inode number and a device number (in the case of
 400  * capturing a WIM image). */
 401 struct wim_inode_table {
 402         /* Fields for the hash table */
 403         struct hlist_head *array;
 404         u64 num_entries;
 405         u64 capacity;
 406
 407         /*
 408          * Linked list of "extra" inodes.  These may be:
 409          *
 410          * - inodes with link count 1, which are all allowed to have 0 for their
 411          *   inode number, meaning we cannot insert them into the hash table.
 412          *
 413          * - Groups we create ourselves by splitting a nominal inode due to
 414          *   inconsistencies in the dentries.  These inodes will share an inode
 415          *   number with some other inode until assign_inode_numbers() is
 416          *   called.
 417          */
 418         struct list_head extra_inodes;
 419 };
 420
 421 /* Common parameters to implementations of building an in-memory dentry tree
 422  * from an on-disk directory structure. */
 423 struct add_image_params {
 424         /* Pointer to the lookup table of the WIM. */
 425         struct wim_lookup_table *lookup_table;
 426
 427         /* Hash table of inodes that have been captured for this tree so far. */
 428         struct wim_inode_table inode_table;
 429
 430         /* The set of security descriptors that have been captured for this
 431          * image so far. */
 432         struct sd_set sd_set;
 433
 434         /* Pointer to the capture configuration, which indicates whether any
 435          * files should be excluded from capture or not. */
 436         const struct wimlib_capture_config *config;
 437
 438         /* Flags that affect the capture operation (WIMLIB_ADD_FLAG_*) */
 439         int add_flags;
 440
 441         /* If non-NULL, the user-supplied progress function. */
 442         wimlib_progress_func_t progress_func;
 443
 444         /* Extra argument; set to point to a pointer to the ntfs_volume for
 445          * libntfs-3g capture.  */
 446         void *extra_arg;
 447
 448         u64 capture_root_ino;
 449         u64 capture_root_dev;
 450 };
 451
 452
 453 /* capture_common.c */
 454
 455 extern bool
 456 exclude_path(const tchar *path, size_t path_len,
 457              const struct wimlib_capture_config *config,
 458              bool exclude_prefix);
 459
 460 extern struct wimlib_capture_config *
 461 copy_capture_config(const struct wimlib_capture_config *config);
 462
 463 extern int
 464 copy_and_canonicalize_capture_config(const struct wimlib_capture_config *config,
 465                                      struct wimlib_capture_config **config_copy_ret);
 466
 467 extern void
 468 free_capture_config(struct wimlib_capture_config *config);
 469
 470 /* extract_image.c */
 471
 472 /* Internal use only */
 473 #define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE         0x80000000
 474 #define WIMLIB_EXTRACT_FLAG_NO_STREAMS          0x40000000
 475 #define WIMLIB_EXTRACT_MASK_PUBLIC              0x3fffffff
 476
 477 /* hardlink.c */
 478
 479 extern int
 480 init_inode_table(struct wim_inode_table *table, size_t capacity);
 481
 482 extern int
 483 inode_table_new_dentry(struct wim_inode_table *table, const tchar *name,
 484                        u64 ino, u64 devno, bool noshare,
 485                        struct wim_dentry **dentry_ret);
 486
 487 extern void
 488 inode_ref_streams(struct wim_inode *inode);
 489
 490 extern void
 491 inode_table_prepare_inode_list(struct wim_inode_table *table,
 492                                struct list_head *head);
 493
 494 static inline void
 495 destroy_inode_table(struct wim_inode_table *table)
 496 {
 497         FREE(table->array);
 498 }
 499
 500
 501 extern int
 502 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
 503
 504 /* header.c */
 505
 506 extern int
 507 read_header(const tchar *filename, int in_fd, struct wim_header *hdr,
 508             int split_ok);
 509
 510 extern int
 511 write_header(const struct wim_header *hdr, int out_fd);
 512
 513 extern int
 514 init_header(struct wim_header *hdr, int ctype);
 515
 516 /* integrity.c */
 517
 518 #define WIM_INTEGRITY_OK 0
 519 #define WIM_INTEGRITY_NOT_OK -1
 520 #define WIM_INTEGRITY_NONEXISTENT -2
 521
 522 extern int
 523 write_integrity_table(int fd,
 524                       struct resource_entry *integrity_res_entry,
 525                       off_t new_lookup_table_end,
 526                       off_t old_lookup_table_end,
 527                       wimlib_progress_func_t progress_func);
 528
 529 extern int
 530 check_wim_integrity(WIMStruct *w, wimlib_progress_func_t progress_func);
 531
 532 /* join.c */
 533
 534 extern void
 535 merge_lookup_tables(WIMStruct *w,
 536                     WIMStruct **additional_swms, unsigned num_additional_swms);
 537
 538 extern void
 539 unmerge_lookup_table(WIMStruct *wim);
 540
 541 /* metadata_resource.c */
 542
 543 extern int
 544 read_metadata_resource(WIMStruct *w,
 545                                   struct wim_image_metadata *image_metadata);
 546
 547 extern int
 548 write_metadata_resource(WIMStruct *w);
 549
 550 /* ntfs-apply.c */
 551
 552 struct apply_args {
 553         WIMStruct *w;
 554         const tchar *target;
 555         unsigned target_nchars;
 556         unsigned wim_source_path_nchars;
 557         struct wim_dentry *extract_root;
 558         tchar *target_realpath;
 559         unsigned target_realpath_len;
 560         int extract_flags;
 561         union wimlib_progress_info progress;
 562         wimlib_progress_func_t progress_func;
 563         int (*apply_dentry)(struct wim_dentry *, void *);
 564         union {
 565         #ifdef WITH_NTFS_3G
 566                 struct {
 567                         /* NTFS apply only */
 568                         struct _ntfs_volume *vol;
 569                 };
 570         #endif
 571         #ifdef __WIN32__
 572                 struct {
 573                         /* Normal apply only (Win32) */
 574                         unsigned long num_set_sacl_priv_notheld;
 575                         unsigned long num_set_sd_access_denied;
 576                         unsigned vol_flags;
 577                         unsigned long num_hard_links_failed;
 578                         unsigned long num_soft_links_failed;
 579                         bool have_vol_flags;
 580                 };
 581         #else
 582                 struct {
 583                         /* Normal apply only (UNIX) */
 584                         unsigned long num_utime_warnings;
 585                 };
 586         #endif
 587         };
 588 };
 589
 590 extern int
 591 apply_dentry_ntfs(struct wim_dentry *dentry, void *arg);
 592
 593 extern int
 594 apply_dentry_timestamps_ntfs(struct wim_dentry *dentry, void *arg);
 595
 596 extern void
 597 libntfs3g_global_init();
 598
 599 /* ntfs-capture.c */
 600
 601 typedef int (*consume_data_callback_t)(const void *buf, size_t len, void *ctx);
 602
 603 extern int
 604 read_ntfs_file_prefix(const struct wim_lookup_table_entry *lte,
 605                       u64 size,
 606                       consume_data_callback_t cb,
 607                       void *ctx_or_buf,
 608                       int _ignored_flags);
 609 extern int
 610 build_dentry_tree_ntfs(struct wim_dentry **root_p,
 611                        const tchar *device,
 612                        struct add_image_params *ctx);
 613
 614 #ifdef WITH_NTFS_3G
 615 extern int
 616 do_ntfs_umount(struct _ntfs_volume *vol);
 617 #endif
 618
 619 /* reparse.c */
 620
 621 /* Structured format for symbolic link, junction point, or mount point reparse
 622  * data. */
 623 struct reparse_data {
 624         /* Reparse point tag (see WIM_IO_REPARSE_TAG_* values) */
 625         u32 rptag;
 626
 627         /* Length of reparse data, not including the 8-byte header (ReparseTag,
 628          * ReparseDataLength, ReparseReserved) */
 629         u16 rpdatalen;
 630
 631         /* ReparseReserved */
 632         u16 rpreserved;
 633
 634         /* Flags (only for WIM_IO_REPARSE_TAG_SYMLINK reparse points).
 635          * SYMBOLIC_LINK_RELATIVE means this is a relative symbolic link;
 636          * otherwise should be set to 0. */
 637 #define SYMBOLIC_LINK_RELATIVE 0x00000001
 638         u32 rpflags;
 639
 640         /* Pointer to the substitute name of the link (UTF-16LE). */
 641         utf16lechar *substitute_name;
 642
 643         /* Pointer to the print name of the link (UTF-16LE). */
 644         utf16lechar *print_name;
 645
 646         /* Number of bytes of the substitute name, not including null terminator
 647          * if present */
 648         u16 substitute_name_nbytes;
 649
 650         /* Number of bytes of the print name, not including null terminator if
 651          * present */
 652         u16 print_name_nbytes;
 653 };
 654
 655 enum {
 656         SUBST_NAME_IS_RELATIVE_LINK = -1,
 657         SUBST_NAME_IS_VOLUME_JUNCTION = -2,
 658         SUBST_NAME_IS_UNKNOWN = -3,
 659 };
 660 extern int
 661 parse_substitute_name(const utf16lechar *substitute_name,
 662                       u16 substitute_name_nbytes,
 663                       u32 rptag);
 664
 665 extern int
 666 parse_reparse_data(const u8 *rpbuf, u16 rpbuflen, struct reparse_data *rpdata);
 667
 668 extern int
 669 make_reparse_buffer(const struct reparse_data *rpdata, u8 *buf);
 670
 671 extern int
 672 wim_inode_get_reparse_data(const struct wim_inode *inode, u8 *rpbuf);
 673
 674 #ifndef __WIN32__
 675 ssize_t
 676 wim_inode_readlink(const struct wim_inode *inode, char *buf, size_t buf_len);
 677
 678 extern int
 679 wim_inode_set_symlink(struct wim_inode *inode, const char *target,
 680                       struct wim_lookup_table *lookup_table);
 681 #endif
 682 extern tchar *
 683 capture_fixup_absolute_symlink(tchar *dest,
 684                                u64 capture_root_ino, u64 capture_root_dev);
 685
 686
 687 /* resource.c */
 688
 689 #define WIMLIB_RESOURCE_FLAG_RAW                0x1
 690 #define WIMLIB_RESOURCE_FLAG_RECOMPRESS         0x4
 691
 692 extern int
 693 read_resource_prefix(const struct wim_lookup_table_entry *lte,
 694                      u64 size, consume_data_callback_t cb, void *ctx_or_buf,
 695                      int flags);
 696
 697 extern const void *
 698 get_resource_entry(const void *p, struct resource_entry *entry);
 699
 700 extern void *
 701 put_resource_entry(void *p, const struct resource_entry *entry);
 702
 703 extern int
 704 read_partial_wim_resource_into_buf(const struct wim_lookup_table_entry *lte,
 705                                    size_t size, u64 offset, void *buf);
 706 extern int
 707 read_full_resource_into_buf(const struct wim_lookup_table_entry *lte, void *buf);
 708
 709 extern int
 710 write_wim_resource(struct wim_lookup_table_entry *lte, int out_fd,
 711                    int out_ctype, struct resource_entry *out_res_entry,
 712                    int flags);
 713
 714 extern int
 715 extract_wim_resource(const struct wim_lookup_table_entry *lte,
 716                      u64 size,
 717                      consume_data_callback_t extract_chunk,
 718                      void *extract_chunk_arg);
 719
 720 extern int
 721 extract_wim_resource_to_fd(const struct wim_lookup_table_entry *lte,
 722                            int fd, u64 size);
 723
 724 extern int
 725 sha1_resource(struct wim_lookup_table_entry *lte);
 726
 727 extern int
 728 copy_resource(struct wim_lookup_table_entry *lte, void *w);
 729
 730 /* security.c */
 731 extern struct wim_security_data *
 732 new_wim_security_data();
 733
 734 extern int
 735 read_security_data(const u8 metadata_resource[],
 736                    u64 metadata_resource_len, struct wim_security_data **sd_p);
 737 extern void
 738 print_security_data(const struct wim_security_data *sd);
 739
 740 extern u8 *
 741 write_security_data(const struct wim_security_data *sd, u8 *p);
 742
 743 extern void
 744 free_security_data(struct wim_security_data *sd);
 745
 746 /* unix_apply.c */
 747 #ifndef __WIN32__
 748 extern int
 749 unix_do_apply_dentry(const char *output_path, size_t output_path_len,
 750                      struct wim_dentry *dentry, struct apply_args *args);
 751 extern int
 752 unix_do_apply_dentry_timestamps(const char *output_path,
 753                                 size_t output_path_len,
 754                                 struct wim_dentry *dentry,
 755                                 struct apply_args *args);
 756 #endif
 757
 758 /* unix_capture.c */
 759 #ifndef __WIN32__
 760 extern int
 761 unix_build_dentry_tree(struct wim_dentry **root_ret,
 762                        const char *root_disk_path,
 763                        struct add_image_params *params);
 764 #endif
 765
 766 /* update_image.c */
 767 extern int
 768 rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to);
 769
 770 /* verify.c */
 771
 772 extern int
 773 verify_dentry(struct wim_dentry *dentry, void *wim);
 774
 775 extern int
 776 wim_run_full_verifications(WIMStruct *w);
 777
 778 extern int
 779 verify_swm_set(WIMStruct *w,
 780                WIMStruct **additional_swms, unsigned num_additional_swms);
 781
 782 /* wim.c */
 783
 784 extern int
 785 select_wim_image(WIMStruct *w, int image);
 786
 787 extern int
 788 for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
 789
 790 extern void
 791 destroy_image_metadata(struct wim_image_metadata *imd,
 792                        struct wim_lookup_table *table,
 793                        bool free_metadata_lte);
 794
 795 extern void
 796 put_image_metadata(struct wim_image_metadata *imd,
 797                    struct wim_lookup_table *table);
 798
 799 extern int
 800 append_image_metadata(WIMStruct *w, struct wim_image_metadata *imd);
 801
 802 extern struct wim_image_metadata *
 803 new_image_metadata();
 804
 805 extern struct wim_image_metadata **
 806 new_image_metadata_array(unsigned num_images);
 807
 808 extern int
 809 wim_checksum_unhashed_streams(WIMStruct *w);
 810
 811 extern int
 812 reopen_wim(WIMStruct *w);
 813
 814 extern int
 815 close_wim(WIMStruct *w);
 816
 817 /* write.c */
 818
 819 /* Internal use only */
 820 #define WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE       0x80000000
 821 #define WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE 0x40000000
 822 #define WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML  0x20000000
 823 #define WIMLIB_WRITE_MASK_PUBLIC                0x1fffffff
 824
 825 /* We are capturing a tree to be placed in the root of the WIM image */
 826 #define WIMLIB_ADD_FLAG_ROOT    0x80000000
 827
 828 extern int
 829 begin_write(WIMStruct *w, const tchar *path, int write_flags);
 830
 831 extern void
 832 close_wim_writable(WIMStruct *w);
 833
 834 extern int
 835 finish_write(WIMStruct *w, int image, int write_flags,
 836              wimlib_progress_func_t progress_func);
 837
 838 #if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
 839 extern int
 840 lock_wim(WIMStruct *w, int fd);
 841 #else
 842 static inline int
 843 lock_wim(WIMStruct *w, int fd)
 844 {
 845         return 0;
 846 }
 847 #endif
 848
 849 #endif /* _WIMLIB_INTERNAL_H */
 850