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         filedes_t in_fd;
 286
 287         /* FILE pointer for the WIM file (if any) currently being written. */
 288         filedes_t out_fd;
 289
 290         /* The name of the WIM file (if any) that has been opened. */
 291         tchar *filename;
 292
 293         /* The lookup table for the WIM file. */
 294         struct wim_lookup_table *lookup_table;
 295
 296         /* Information retrieved from the XML data, arranged in an orderly
 297          * manner. */
 298         struct wim_info *wim_info;
 299
 300         /* Array of the image metadata, one for each image in the WIM. */
 301         struct wim_image_metadata **image_metadata;
 302
 303         /* The header of the WIM file. */
 304         struct wim_header hdr;
 305
 306         /* Temporary field */
 307         void *private;
 308
 309         /* The currently selected image, indexed starting at 1.  If not 0,
 310          * subtract 1 from this to get the index of the current image in the
 311          * image_metadata array. */
 312         int current_image;
 313
 314         u8 deletion_occurred : 1;
 315         u8 all_images_verified : 1;
 316         u8 wim_locked : 1;
 317 };
 318
 319 /* Inline utility functions for WIMStructs. */
 320
 321 static inline struct wim_image_metadata *
 322 wim_get_current_image_metadata(WIMStruct *w)
 323 {
 324         return w->image_metadata[w->current_image - 1];
 325 }
 326
 327 static inline const struct wim_image_metadata *
 328 wim_get_const_current_image_metadata(const WIMStruct *w)
 329 {
 330         return w->image_metadata[w->current_image - 1];
 331 }
 332
 333 static inline struct wim_dentry *
 334 wim_root_dentry(WIMStruct *w)
 335 {
 336         return wim_get_current_image_metadata(w)->root_dentry;
 337 }
 338
 339 static inline struct wim_security_data *
 340 wim_security_data(WIMStruct *w)
 341 {
 342         return wim_get_current_image_metadata(w)->security_data;
 343 }
 344
 345 static inline const struct wim_security_data *
 346 wim_const_security_data(const WIMStruct *w)
 347 {
 348         return wim_get_const_current_image_metadata(w)->security_data;
 349 }
 350
 351 /* Nonzero if a struct resource_entry indicates a compressed resource. */
 352 static inline int
 353 resource_is_compressed(const struct resource_entry *entry)
 354 {
 355         return (entry->flags & WIM_RESHDR_FLAG_COMPRESSED);
 356 }
 357
 358 /* Iterate over each inode in a WIM image that has not yet been hashed */
 359 #define image_for_each_inode(inode, imd) \
 360         list_for_each_entry(inode, &imd->inode_list, i_list)
 361
 362 /* Iterate over each stream in a WIM image that has not yet been hashed */
 363 #define image_for_each_unhashed_stream(lte, imd) \
 364         list_for_each_entry(lte, &imd->unhashed_streams, unhashed_list)
 365
 366 /* Iterate over each stream in a WIM image that has not yet been hashed (safe
 367  * against stream removal) */
 368 #define image_for_each_unhashed_stream_safe(lte, tmp, imd) \
 369         list_for_each_entry_safe(lte, tmp, &imd->unhashed_streams, unhashed_list)
 370
 371 #if 1
 372 #  define copy_resource_entry(dst, src) memcpy(dst, src, sizeof(struct resource_entry))
 373 #  define zero_resource_entry(entry) memset(entry, 0, sizeof(struct resource_entry))
 374 #else
 375 static inline void
 376 copy_resource_entry(struct resource_entry *dst,
 377                     const struct resource_entry *src)
 378 {
 379         BUILD_BUG_ON(sizeof(struct resource_entry) != 24);
 380         ((u64*)dst)[0] = ((u64*)src)[0];
 381         ((u64*)dst)[1] = ((u64*)src)[1];
 382         ((u64*)dst)[2] = ((u64*)src)[2];
 383 }
 384
 385 static inline void
 386 zero_resource_entry(struct resource_entry *entry)
 387 {
 388         BUILD_BUG_ON(sizeof(struct resource_entry) != 24);
 389         ((u64*)entry)[0] = 0;
 390         ((u64*)entry)[1] = 0;
 391         ((u64*)entry)[2] = 0;
 392 }
 393 #endif
 394
 395 /* add_image.c */
 396
 397 /* Hash table to find inodes, given an inode number (in the case of reading
 398  * a WIM images), or both an inode number and a device number (in the case of
 399  * capturing a WIM image). */
 400 struct wim_inode_table {
 401         /* Fields for the hash table */
 402         struct hlist_head *array;
 403         u64 num_entries;
 404         u64 capacity;
 405
 406         /*
 407          * Linked list of "extra" inodes.  These may be:
 408          *
 409          * - inodes with link count 1, which are all allowed to have 0 for their
 410          *   inode number, meaning we cannot insert them into the hash table.
 411          *
 412          * - Groups we create ourselves by splitting a nominal inode due to
 413          *   inconsistencies in the dentries.  These inodes will share an inode
 414          *   number with some other inode until assign_inode_numbers() is
 415          *   called.
 416          */
 417         struct list_head extra_inodes;
 418 };
 419
 420 /* Common parameters to implementations of building an in-memory dentry tree
 421  * from an on-disk directory structure. */
 422 struct add_image_params {
 423         /* Pointer to the lookup table of the WIM. */
 424         struct wim_lookup_table *lookup_table;
 425
 426         /* Pointer to a hash table of inodes that have been captured for this
 427          * WIM image so far. */
 428         struct wim_inode_table *inode_table;
 429
 430         /* Pointer to the set of security descriptors that have been captured
 431          * for this 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_IMAGE_FLAG_*) */
 439         int add_image_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 extern bool
 453 exclude_path(const tchar *path, size_t path_len,
 454              const struct wimlib_capture_config *config,
 455              bool exclude_prefix);
 456
 457 /* extract_image.c */
 458
 459 /* Internal use only */
 460 #define WIMLIB_EXTRACT_FLAG_MULTI_IMAGE         0x80000000
 461 #define WIMLIB_EXTRACT_FLAG_NO_STREAMS          0x40000000
 462 #define WIMLIB_EXTRACT_MASK_PUBLIC              0x3fffffff
 463
 464 /* hardlink.c */
 465
 466 extern int
 467 init_inode_table(struct wim_inode_table *table, size_t capacity);
 468
 469 extern int
 470 inode_table_new_dentry(struct wim_inode_table *table, const tchar *name,
 471                        u64 ino, u64 devno, bool noshare,
 472                        struct wim_dentry **dentry_ret);
 473
 474 extern void
 475 inode_ref_streams(struct wim_inode *inode);
 476
 477 extern void
 478 inode_table_prepare_inode_list(struct wim_inode_table *table,
 479                                struct list_head *head);
 480
 481 static inline void
 482 destroy_inode_table(struct wim_inode_table *table)
 483 {
 484         FREE(table->array);
 485 }
 486
 487
 488 extern int
 489 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
 490
 491 /* header.c */
 492
 493 extern int
 494 read_header(filedes_t in_fd, struct wim_header *hdr, int split_ok);
 495
 496 extern int
 497 write_header(const struct wim_header *hdr, filedes_t out_fd);
 498
 499 extern int
 500 init_header(struct wim_header *hdr, int ctype);
 501
 502 /* integrity.c */
 503
 504 #define WIM_INTEGRITY_OK 0
 505 #define WIM_INTEGRITY_NOT_OK -1
 506 #define WIM_INTEGRITY_NONEXISTENT -2
 507
 508 extern int
 509 write_integrity_table(filedes_t fd,
 510                       struct resource_entry *integrity_res_entry,
 511                       off_t new_lookup_table_end,
 512                       off_t old_lookup_table_end,
 513                       wimlib_progress_func_t progress_func);
 514
 515 extern int
 516 check_wim_integrity(WIMStruct *w, wimlib_progress_func_t progress_func);
 517
 518 /* join.c */
 519
 520 extern int
 521 new_joined_lookup_table(WIMStruct *w, WIMStruct **additional_swms,
 522                         unsigned num_additional_swms,
 523                         struct wim_lookup_table **table_ret);
 524
 525 /* metadata_resource.c */
 526
 527 extern int
 528 read_metadata_resource(WIMStruct *w,
 529                                   struct wim_image_metadata *image_metadata);
 530
 531 extern int
 532 write_metadata_resource(WIMStruct *w);
 533
 534 /* ntfs-apply.c */
 535
 536 struct apply_args {
 537         WIMStruct *w;
 538         const tchar *target;
 539         tchar *target_realpath;
 540         unsigned target_realpath_len;
 541         int extract_flags;
 542         union wimlib_progress_info progress;
 543         wimlib_progress_func_t progress_func;
 544         int (*apply_dentry)(struct wim_dentry *, void *);
 545         union {
 546         #ifdef WITH_NTFS_3G
 547                 struct {
 548                         /* NTFS apply only */
 549                         struct _ntfs_volume *vol;
 550                 };
 551         #endif
 552         #ifdef __WIN32__
 553                 struct {
 554                         /* Normal apply only (Win32) */
 555                         unsigned long num_set_sacl_priv_notheld;
 556                         unsigned long num_set_sd_access_denied;
 557                         unsigned vol_flags;
 558                         unsigned long num_hard_links_failed;
 559                         bool have_vol_flags;
 560                 };
 561         #else
 562                 struct {
 563                         /* Normal apply only (UNIX) */
 564                         unsigned long num_utime_warnings;
 565                 };
 566         #endif
 567         };
 568 };
 569
 570 extern int
 571 apply_dentry_ntfs(struct wim_dentry *dentry, void *arg);
 572
 573 extern int
 574 apply_dentry_timestamps_ntfs(struct wim_dentry *dentry, void *arg);
 575
 576 extern void
 577 libntfs3g_global_init();
 578
 579 /* ntfs-capture.c */
 580
 581 typedef int (*consume_data_callback_t)(const void *buf, size_t len, void *ctx);
 582
 583 extern int
 584 read_ntfs_file_prefix(const struct wim_lookup_table_entry *lte,
 585                       u64 size,
 586                       consume_data_callback_t cb,
 587                       void *ctx_or_buf,
 588                       int _ignored_flags);
 589 extern int
 590 build_dentry_tree_ntfs(struct wim_dentry **root_p,
 591                        const tchar *device,
 592                        struct add_image_params *ctx);
 593
 594 #ifdef WITH_NTFS_3G
 595 extern int
 596 do_ntfs_umount(struct _ntfs_volume *vol);
 597 #endif
 598
 599 /* reparse.c */
 600
 601 /* Structured format for symbolic link, junction point, or mount point reparse
 602  * data. */
 603 struct reparse_data {
 604         /* Reparse point tag (see WIM_IO_REPARSE_TAG_* values) */
 605         u32 rptag;
 606
 607         /* Length of reparse data, not including the 8-byte header (ReparseTag,
 608          * ReparseDataLength, ReparseReserved) */
 609         u16 rpdatalen;
 610
 611         /* ReparseReserved */
 612         u16 rpreserved;
 613
 614         /* Flags (only for WIM_IO_REPARSE_TAG_SYMLINK reparse points).
 615          * SYMBOLIC_LINK_RELATIVE means this is a relative symbolic link;
 616          * otherwise should be set to 0. */
 617 #define SYMBOLIC_LINK_RELATIVE 0x00000001
 618         u32 rpflags;
 619
 620         /* Pointer to the substitute name of the link (UTF-16LE). */
 621         utf16lechar *substitute_name;
 622
 623         /* Pointer to the print name of the link (UTF-16LE). */
 624         utf16lechar *print_name;
 625
 626         /* Number of bytes of the substitute name, not including null terminator
 627          * if present */
 628         u16 substitute_name_nbytes;
 629
 630         /* Number of bytes of the print name, not including null terminator if
 631          * present */
 632         u16 print_name_nbytes;
 633 };
 634
 635 enum {
 636         SUBST_NAME_IS_RELATIVE_LINK = -1,
 637         SUBST_NAME_IS_VOLUME_JUNCTION = -2,
 638         SUBST_NAME_IS_UNKNOWN = -3,
 639 };
 640 extern int
 641 parse_substitute_name(const utf16lechar *substitute_name,
 642                       u16 substitute_name_nbytes,
 643                       u32 rptag);
 644
 645 extern int
 646 parse_reparse_data(const u8 *rpbuf, u16 rpbuflen, struct reparse_data *rpdata);
 647
 648 extern int
 649 make_reparse_buffer(const struct reparse_data *rpdata, u8 *buf);
 650
 651 extern int
 652 wim_inode_get_reparse_data(const struct wim_inode *inode, u8 *rpbuf);
 653
 654 #ifndef __WIN32__
 655 ssize_t
 656 wim_inode_readlink(const struct wim_inode *inode, char *buf, size_t buf_len);
 657
 658 extern int
 659 wim_inode_set_symlink(struct wim_inode *inode, const char *target,
 660                       struct wim_lookup_table *lookup_table);
 661 #endif
 662 extern tchar *
 663 capture_fixup_absolute_symlink(tchar *dest,
 664                                u64 capture_root_ino, u64 capture_root_dev);
 665
 666
 667 /* resource.c */
 668
 669 #define WIMLIB_RESOURCE_FLAG_RAW                0x1
 670 #define WIMLIB_RESOURCE_FLAG_RECOMPRESS         0x4
 671
 672 extern int
 673 read_resource_prefix(const struct wim_lookup_table_entry *lte,
 674                      u64 size, consume_data_callback_t cb, void *ctx_or_buf,
 675                      int flags);
 676
 677 extern const void *
 678 get_resource_entry(const void *p, struct resource_entry *entry);
 679
 680 extern void *
 681 put_resource_entry(void *p, const struct resource_entry *entry);
 682
 683 extern int
 684 read_partial_wim_resource_into_buf(const struct wim_lookup_table_entry *lte,
 685                                    size_t size, u64 offset, void *buf);
 686 extern int
 687 read_full_resource_into_buf(const struct wim_lookup_table_entry *lte, void *buf);
 688
 689 extern int
 690 write_wim_resource(struct wim_lookup_table_entry *lte, filedes_t out_fd,
 691                    int out_ctype, struct resource_entry *out_res_entry,
 692                    int flags);
 693
 694 extern int
 695 extract_wim_resource(const struct wim_lookup_table_entry *lte,
 696                      u64 size,
 697                      consume_data_callback_t extract_chunk,
 698                      void *extract_chunk_arg);
 699
 700 extern int
 701 extract_wim_resource_to_fd(const struct wim_lookup_table_entry *lte,
 702                            int fd, u64 size);
 703
 704 extern int
 705 sha1_resource(struct wim_lookup_table_entry *lte);
 706
 707 extern int
 708 copy_resource(struct wim_lookup_table_entry *lte, void *w);
 709
 710 /* security.c */
 711 extern int
 712 read_security_data(const u8 metadata_resource[],
 713                    u64 metadata_resource_len, struct wim_security_data **sd_p);
 714 extern void
 715 print_security_data(const struct wim_security_data *sd);
 716
 717 extern u8 *
 718 write_security_data(const struct wim_security_data *sd, u8 *p);
 719
 720 extern void
 721 free_security_data(struct wim_security_data *sd);
 722
 723 /* verify.c */
 724
 725 extern int
 726 verify_dentry(struct wim_dentry *dentry, void *wim);
 727
 728 extern int
 729 wim_run_full_verifications(WIMStruct *w);
 730
 731 extern int
 732 verify_swm_set(WIMStruct *w,
 733                WIMStruct **additional_swms, unsigned num_additional_swms);
 734
 735 /* wim.c */
 736
 737 extern int
 738 select_wim_image(WIMStruct *w, int image);
 739
 740 extern int
 741 for_image(WIMStruct *w, int image, int (*visitor)(WIMStruct *));
 742
 743 extern void
 744 destroy_image_metadata(struct wim_image_metadata *imd,
 745                        struct wim_lookup_table *table,
 746                        bool free_metadata_lte);
 747
 748 extern void
 749 put_image_metadata(struct wim_image_metadata *imd,
 750                    struct wim_lookup_table *table);
 751
 752 extern int
 753 append_image_metadata(WIMStruct *w, struct wim_image_metadata *imd);
 754
 755 extern struct wim_image_metadata *
 756 new_image_metadata();
 757
 758 extern struct wim_image_metadata **
 759 new_image_metadata_array(unsigned num_images);
 760
 761 extern int
 762 wim_checksum_unhashed_streams(WIMStruct *w);
 763
 764 extern int
 765 reopen_wim(WIMStruct *w);
 766
 767 extern int
 768 close_wim(WIMStruct *w);
 769
 770 /* write.c */
 771
 772 /* Internal use only */
 773 #define WIMLIB_WRITE_FLAG_NO_LOOKUP_TABLE       0x80000000
 774 #define WIMLIB_WRITE_FLAG_REUSE_INTEGRITY_TABLE 0x40000000
 775 #define WIMLIB_WRITE_FLAG_CHECKPOINT_AFTER_XML  0x20000000
 776 #define WIMLIB_WRITE_MASK_PUBLIC                0x1fffffff
 777
 778 /* We are capturing a tree to be placed in the root of the WIM image */
 779 #define WIMLIB_ADD_IMAGE_FLAG_ROOT      0x80000000
 780
 781 /* We are capturing a dentry that will become the root of a tree to be added to
 782  * the WIM image */
 783 #define WIMLIB_ADD_IMAGE_FLAG_SOURCE    0x40000000
 784
 785 extern int
 786 begin_write(WIMStruct *w, const tchar *path, int write_flags);
 787
 788 extern void
 789 close_wim_writable(WIMStruct *w);
 790
 791 extern int
 792 finish_write(WIMStruct *w, int image, int write_flags,
 793              wimlib_progress_func_t progress_func);
 794
 795 #if defined(HAVE_SYS_FILE_H) && defined(HAVE_FLOCK)
 796 extern int
 797 lock_wim(WIMStruct *w, filedes_t fd);
 798 #else
 799 static inline int
 800 lock_wim(WIMStruct *w, filedes_t fd)
 801 {
 802         return 0;
 803 }
 804 #endif
 805
 806 #endif /* _WIMLIB_INTERNAL_H */
 807