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